doc fix for run_arg usage

automl · Apr 15, 2024 · cde54f9 · cde54f9
1 parent e8821d6
commit cde54f9
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/neps_run.md b/docs/neps_run.md
@@ -105,7 +105,7 @@ an example of how to structure your YAML configuration.
 ```yaml
 run_args:  # Essential starting key; everything under this key gets considered for configuration.
   run_pipeline:
-    path: "path/to/your/run_pipeline" # File path of the run_pipeline function
+    path: "path/to/your/run_pipeline.py" # File path of the run_pipeline function
     name: "name_of_your_run_pipeline" # Function name
   pipeline_space: "path/to/your/search_space.yaml" # Path of the search space yaml file
   root_directory: "neps_results"  # Output directory for results

diff --git a/neps_examples/yaml_usage/hpo_example.py b/neps_examples/yaml_usage/hpo_example.py
@@ -124,5 +124,5 @@ def training_pipeline(num_layers, num_neurons, epochs, learning_rate, optimizer)
     # Run optimization using neps.run(...). Arguments can be provided directly to neps.run
     # or defined in a configuration file (e.g., "run_args.yaml") passed through
     # the run_args parameter.
-    # neps.run(run_args="run_args.yaml")
-    neps.run(run_args="run_args_alternative.yaml")
+    neps.run(run_args="run_args.yaml")
+    # neps.run(run_args="run_args_alternative.yaml")