add test config comment (#2389)

kubeflow · Oct 15, 2019 · 09171d7 · 09171d7
1 parent fb614f0
commit 09171d7
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/test/sample-test/configs/schema.config.yaml b/test/sample-test/configs/schema.config.yaml
@@ -14,7 +14,15 @@
 
 # This is the schema for sample test config yaml file.
 test_name: str()
+# Parameters for python samples.
+# If 'output' is specified, values will be dynamically injected
 arguments: map(required=False)
+# Parameters for notebook samples. 
+# If 'output' is specified, values will be dynamically injected
 notebook_params: map(required=False)
+# Timeout
 test_timeout: int(min=0, required=False)
+# For python samples, run_pipeline means submiting the pipeline
+# run; For notebook samples, run_pipeline means checking the 
+# run results assuming the notebook codes already submit the run.
 run_pipeline: bool(required=False)