added documentation to api examples

Author: KrissiHub

CHANGELOG.md

@@ -1,3 +1,8 @@
+# Version 1.3.7
+
+## Documentation
+- Added the hint that for the api example the example records need to be run first to create the run.
+
 # Version 1.3.6
 
 ## New SMAC version compatibility

examples/api/ablation_paths.py

@@ -4,6 +4,7 @@
 
 This example shows how to use the plugin Ablation Paths.
 Note that other plugins use the same interfaces and can be used in the same fashion.
+To use the API commands the according record example needs to be run in order create the run to analyze.
 """
 
 from deepcave.plugins.hyperparameter.ablation_paths import AblationPaths

examples/api/importances.py

@@ -4,6 +4,7 @@
 
 This example shows how to use the plugin Importances.
 Note that other plugins use the same interfaces and can be used in the same fashion.
+To use the API commands the according record example needs to be run in order create the run to analyze.
 """
 
 from deepcave.plugins.hyperparameter.importances import Importances

examples/api/parallel_coordinates.py

@@ -4,6 +4,7 @@
 
 This example shows how to use the plugin Parallel Coordinates.
 Note that other plugins use the same interfaces and can be used in the same fashion.
+To use the API commands the according record example needs to be run in order create the run to analyze.
 """
 
 from deepcave.plugins.hyperparameter.parallel_coordinates import ParallelCoordinates

examples/api/pdp.py

@@ -4,6 +4,7 @@
 
 This example shows how to use the plugin Partial Dependencies.
 Note that other plugins use the same interfaces and can be used in the same fashion.
+To use the API commands the according record example needs to be run in order create the run to analyze.
 """
 
 from deepcave.plugins.hyperparameter.pdp import PartialDependencies