diff --git a/docs/experiments.md b/docs/experiments.md index 3eb38eb..76dbdf6 100644 --- a/docs/experiments.md +++ b/docs/experiments.md @@ -21,6 +21,10 @@ read ``YAML`` configuration files to setup some experimental parameters. This can be extended to support more specific experiment helpers (see e.g. experimaestro-ir for an example). +`ConfigurationBase` should be the parent class of any configuration. + +::: experimaestro.scheduler.services.ConfigurationBase + ### Example An `experiment.py` file: diff --git a/docs/tutorial.md b/docs/tutorial.md index 5fa8e5c..4971fef 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -79,24 +79,6 @@ Taking the configuration class `Adam` defined above, we have: - `Adam(lr=1e-2).__identifier__()` returns `71848...` (different set of parameters) -First, any value can be -associated with a unique byte string: the byte string is obtained by outputting -the type of the value (e.g. string, ir.adhoc.dataset) and the value itself as a -binary string. A special handling of configurations and tasks (objects) is -performed by sorting keys in ascending lexicographic order, thus ensuring the -uniqueness of the representation. - - Moreover - -- Default values are removed (e.g. k1 when set to 0.9). This allows to - handle the situation where one adds a new experimental parameter - (e.g. a new loss component). In that case, using a default parameter - allows to add this parameter without invalidating all the previously - ran experiments. -- Ignored values are removed (e.g. the number of threads when - indexing, the path where the index is stored) - - # Tasks When it comes to actually running code, Experimaestro allows to define diff --git a/src/experimaestro/experiments/configuration.py b/src/experimaestro/experiments/configuration.py index 043f8d8..273d351 100644 --- a/src/experimaestro/experiments/configuration.py +++ b/src/experimaestro/experiments/configuration.py @@ -28,5 +28,5 @@ class ConfigurationBase: file: str = "experiment" """qualified name (relative to the module) for the file containing a run function""" - parent: Optional[str] + parent: Optional[str] = None """Relative path of a YAML file that should be merged"""