Example documentation location

[dooglewoogle]

Hi I'm trying to write some additions to the Model Optimization example documentation, specifically around obtaining and loading a dataset.
Is this documentaton generated from the .py file, or is there a .rst I've missed?
Thanks

[pmeier]

Hey and welcome @dooglewoogle! The usage examples are generated by sphinx-gallery. You can find its config here:

pystiche/docs/source/conf.py

Lines 280 to 283 in c6069f9

	sphinx_gallery_conf = {
	"examples_dirs": PROJECT_ROOT / "examples",
	"gallery_dirs": pathlib.Path("galleries") / "examples",
	"filename_pattern": re.escape(os.sep) + r"example_\w+[.]py$",

It will build all files in example_dirs that match filename_pattern. You are looking for

pystiche/examples/advanced/example_model_optimization.py

Line 303 in c6069f9

# Depending on the dataset and your setup the training can take a couple of hours. To

I'm happy you want to contribute! You can follow the contribution guide to see how you can build the documentation. If you only want to change text or code that does not affect the output, I suggest you run with PYSTICHE_PLOT_GALLERY=0 to avoid building the examples, because that will take some time.