Config doc (#694)

Add README.md to example/config/, explaining experiment.yaml, audition.yaml, postmodeling_config.yaml and postmodeling_crosstabs.yaml Remove feature.yaml and change documentation of feature-testing since cli.py just takes an experiment config.
dssg · May 21, 2019 · 5342254 · 5342254
1 parent e97aab1
commit 5342254
Show file tree

Hide file tree

Showing 5 changed files with 263 additions and 116 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -74,6 +74,7 @@ nav:
   - Experiment:
     - Defining an Experiment: experiments/defining.md
     - Testing Feature Configuration: experiments/feature-testing.md
+    - Experiment Configuration: https://github.com/dssg/triage/blob/master/example/config/README.md
     - Running an Experiment: experiments/running.md
     - Upgrading an Experiment:
         - v6 -> v7: experiments/upgrade-to-v7.md

diff --git a/docs/sources/experiments/feature-testing.md b/docs/sources/experiments/feature-testing.md
@@ -8,10 +8,10 @@ To speed up the process of iterating on features, you can run a list of feature
 ![triage featuretest cli help screen](featuretest-cli.png)
 
 The command-line interface for testing features takes in two arguments:
-	- A feature config file. Refer to [example_feature_config.yaml](https://github.com/dssg/triage/blob/master/example/config/feature.yaml). Essentially this is the content of the [example_experiment_config.yaml](https://github.com/dssg/triage/blob/master/example/config/experiment.yaml)'s `feature_aggregations` section. It consists of a YAML list, with one or more feature_aggregation rows present.
+	- An experiment config file. Refer to the [example_experiment_config.yaml](https://github.com/dssg/triage/blob/master/example/config/experiment.yaml)'s `feature_aggregations` section. It consists of a YAML list, with one or more feature_aggregation rows present.
 	- An as-of-date. This should be in the format `2016-01-01`.
 
-Example: `triage experiment featuretest example/config/feature.yaml 2016-01-01`
+Example: `triage experiment featuretest example/config/experiment.yaml 2016-01-01`
 
 All given feature aggregations will be processed for the given date. You will see a bunch of queries pass by in your terminal, populating tables in the `features_test` schema which you can inspect afterwards.