Bump experiment to v7

docs/mkdocs.yml

@@ -75,7 +75,10 @@ nav:
     - Defining an Experiment: experiments/defining.md
     - Testing Feature Configuration: experiments/feature-testing.md
     - Running an Experiment: experiments/running.md
-    - Upgrading an Experiment: experiments/upgrading.md
+    - Upgrading an Experiment:
+        - v6 -> v7: experiments/upgrade-to-v7.md
+        - v5 -> v6: experiments/upgrade-to-v6.md
+        - v3/v4 -> v5: experiments/upgrade-to-v5.md
     - Temporal Validation Deep Dive: experiments/temporal-validation.md
     - Cohort and Label Deep Dive: experiments/cohort-labels.md
     - Prediction Ranking: experiments/prediction-ranking.md

docs/sources/experiments/upgrade-to-v7.md

@@ -0,0 +1,26 @@
+# Upgrading your experiment configuration to v7
+
+
+This document details the steps needed to update a triage v6 configuration to
+v7, mimicking the old behavior.
+
+Experiment configuration v7 includes only one change from v6: the addition of a mandatory random_seed, that is set at the beginning of the experiment and affects all subsequent random numbers. It is expected to be an integer.
+
+Old:
+```yaml
+
+config_version: 'v6'
+
+# EXPERIMENT METADATA
+```
+
+New:
+```yaml
+
+config_version: 'v7'
+
+# EXPERIMENT METADATA
+# random_seed will be set in Python at the beginning of the experiment and 
+# affect the generation of all model seeds
+random_seed: 23895478
+```

example/config/experiment.yaml

@@ -5,7 +5,7 @@
 # old configuration files are released. Be sure to assign the config version
 # that matches the triage.experiments.CONFIG_VERSION in the triage release
 # you are developing against!
-config_version: 'v6'
+config_version: 'v7'
 
 # EXPERIMENT METADATA
 # model_comment (optional) will end up in the model_comment column of the

src/triage/experiments/__init__.py

@@ -1,5 +1,5 @@
 # Avoid circular import (required by base)
-CONFIG_VERSION = "v6"  # noqa: E402
+CONFIG_VERSION = "v7"  # noqa: E402
 
 from .base import ExperimentBase
 from .multicore import MultiCoreExperiment