lincc-frameworks / lincc-frameworks/hyrax
Docs: explain custom iterable datasets
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 7
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 8
Description
Currently, the documentation for custom datasets states that the constructor of the custom dataset takes `config` and optional `metadata_table` arguments only. However, `hyrax.pytorch_ignite.setup_dataset` calls it with a `data_location` argument, which is not documented:
https://github.com/lincc-frameworks/hyrax/blob/a0f86594699e34654bc6e68f7230f63dcde575b4/src/hyrax/pytorch_ignite.py#L110
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
Read src/hyrax/pytorch_ignite.py at line 110, where setup_dataset passes data_location, and compare that call with the custom dataset documentation. Update the documentation to explain the data_location argument and ensure the documented constructor matches the supported call. Done when users can understand all arguments passed by setup_dataset.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, pytorch
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100