Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include example config for ctapipe-train-disp-reconstructor in quickstart tool #2414

Merged
merged 3 commits into from
Oct 20, 2023
Merged

Include example config for ctapipe-train-disp-reconstructor in quickstart tool #2414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
864ff3a
Add ctapipe-train-disp-reconstructor config to quickstart tool
LukasBeiske Oct 20, 2023
4cfc82a
Add changelog
LukasBeiske Oct 20, 2023
81cd459
Add note about performance of provided ml configs
LukasBeiske Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions ctapipe/tools/quickstart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"ml_preprocessing_config.yaml",
"train_energy_regressor.yaml",
"train_particle_classifier.yaml",
"train_disp_reconstructor.yaml",
]

README_TEXT = f"""
Expand Down Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add proper configuration files for use with ctapipe-quickstart, not the unit test files with slimmed down simplified configurations as we have them here.

Ok for now, but maybe add a note that these files are optimized for very fast training for demos and unit tests and will not result in good performance?

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}
Expand Down
2 changes: 2 additions & 0 deletions docs/changes/2414.bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add the example config for ctapipe-train-disp-reconstructor
to the list of configs generated by ctapipe-quickstart.