Merge pull request #2414 from LukasBeiske/add_disp_to_quickstart

Include example config for ctapipe-train-disp-reconstructor in quickstart tool
cta-observatory · Oct 20, 2023 · d938be4 · d938be4
2 parents 7d32c65 + 81cd459
commit d938be4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/ctapipe/tools/quickstart.py b/ctapipe/tools/quickstart.py
@@ -17,6 +17,7 @@
     "ml_preprocessing_config.yaml",
     "train_energy_regressor.yaml",
     "train_particle_classifier.yaml",
+    "train_disp_reconstructor.yaml",
 ]
 
 README_TEXT = f"""
@@ -55,13 +56,16 @@
 ctapipe-process --help-all
 ```
 
-## ctapipe-train-energy-regressor / ctapipe-train-particle-classifier configs
+## ctapipe-train-energy-regressor / ctapipe-train-particle-classifier / ctapipe-train-disp-reconstructor configs
 
 Included here are also base configurations for training machine learning (ML)
-models for energy regression and gamma/hadron separation.
+models for energy regression, gamma/hadron separation and disp origin reconstruction.
+NOTE: As these files are used for unit tests, they are optimized for very fast training
+and will not result in well performing models.
 
 - `train_energy_regressor.yaml`: configuration of energy regression model
 - `train_particle_classifier.yaml`: configuration of particle classification model
+- `train_disp_reconstructor.yaml`: configuration of disp reconstruction models
 
 
 This file was generated using ctapipe version {VERSION}

diff --git a/docs/changes/2414.bugfix.rst b/docs/changes/2414.bugfix.rst
@@ -0,0 +1,2 @@
+Add the example config for ctapipe-train-disp-reconstructor 
+to the list of configs generated by ctapipe-quickstart.