lincc-frameworks / lincc-frameworks/hyrax
Validate certain configs after `h.set_config`
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 7
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 8
Description
This is a follow up after #950.
It would be nice and helpful for the user if there was:
- Validation of certain fields after running
h.set_configfor instancebalanceis a bit complicated, so immediate feedback would be good. The field that brings this up isbalance, butdata_request,split,labelare all interrelated, so cross-validation for all of those would be great.. - Logging that shows what the final state of the config is after running set_config. This would be an indicator for the user of whether they should use
h.set_config(<field>, <value>, over_write=True)
Contributor guide
No contributing guide indexed for this repository
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 implementation and callers of h.set_config, then trace how balance, data_request, split, and label are stored and related. Define the validation cases and final-state logging from the existing configuration behavior; done means invalid combinations provide immediate feedback and the resulting configuration state is visible after set_config.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- machine-learning
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100