Split the package installation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 25
- Forks
- 6
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 1
Description
In #108, we added a new directory ml_models to store experimental nn.Modules. This was done to support swapping a physical component, not to train or validate the wofost crop model. The models in ml_models are therefore experimental, and results from the wofost crop model using them are not validated in this package. We keep ml_models in the main branch to maintain them and include them in releases, Zenodo publications, and documentation. It also serves as a reference for researchers on how to develop and integrate their own models into the diffWOFOST ecosystem.
If ml_models grows, it could make installation heavier and harder to maintain quality (e.g., testing on GitHub runners). One option is to split it into extras, for example:
pip install diffwofost (physical models only)
pip install diffwofost[ml_models] (physical + ML models)
This isn’t urgent and can be addressed later.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the package metadata and current installation and release configuration, then inspect how ml_models is included and tested on GitHub runners. Compare the base and ml_models installations, and verify that releases, Zenodo publications, and documentation still include the experimental models appropriately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100