diff --git a/README.md b/README.md index f60034b3..5f0120e6 100644 --- a/README.md +++ b/README.md @@ -241,9 +241,10 @@ from disent.data.groundtruth import XYObjectData from disent.dataset.groundtruth import GroundTruthDataset from disent.frameworks.vae import BetaVae from disent.metrics import metric_dci, metric_mig -from disent.model.ae import EncoderConv64, DecoderConv64, AutoEncoder +from disent.model.ae import EncoderConv64, DecoderConv64 +from disent.model import AutoEncoder +from disent.nn.transform import ToStandardisedTensor from disent.schedule import CyclicSchedule -from disent.transform import ToStandardisedTensor # We use this internally to test this script. # You can remove all references to this in your own code. @@ -298,4 +299,46 @@ print('metrics:', metrics) Visit the [docs](https://disent.dontpanic.sh) for more examples! + +---------------------- + +### Hydra Experiment Example + +The entrypoint for basic experiments is `experiments/run.py`. + +Some configuration will be required, but basic experiments can +be adjusted by modifying the [Hydra Config 1.0](https://github.com/facebookresearch/hydra) +files in `experiment/config`. + +Modifying the main `experiment/config/config.yaml` is all you +need for most basic experiments. The main config file contains +a defaults list with entries corresponding to yaml configuration +files (config options) in the subfolders (config groups) in +`experiment/config//