diff --git a/website/docs/patterns/configuring_experiments.md b/website/docs/patterns/configuring_experiments.md index 5ee662f590..b1cb9969b6 100644 --- a/website/docs/patterns/configuring_experiments.md +++ b/website/docs/patterns/configuring_experiments.md @@ -11,19 +11,58 @@ This page shows how to use Hydra to create a file per experiment, overriding con To avoid clutter, we will place the experiment config files in dedicated config group called *experiment*. Below an example config directory structure before creating the *experiment* config group: +
-
+
```text title="Directory structure" -├── conf -│ ├── config.yaml -│ ├── db -│ │ ├── mysql.yaml -│ │ └── sqlite.yaml -│ └── server -│ ├── apache.yaml -│ └── nginx.yaml -└── my_app.py +├── config.yaml +├── db +│ ├── mysql.yaml +│ └── sqlite.yaml +└── server + ├── apache.yaml + └── nginx.yaml + +``` +
+
+ +```yaml title="db/mysql.yaml" +name: sqlite +``` + +```yaml title="server/apache.yaml" +name: apache +port: 80 +``` +
+ + +
+ +```yaml title="db/sqlite.yaml" +name: sqlite +``` + +```yaml title="server/nginx.yaml" +name: nginx +port: 80 +``` +
+
+ + + +
+
+ +```yaml title="config.yaml" +defaults: + - db: mysql + - server: apache + + ```
@@ -34,10 +73,6 @@ db: server: name: apache port: 80 - - - - ```