openclimatefix / openclimatefix/ocf-data-sampler
add documentation of samples
Open
Nobody has claimed this yet.
ocf-internal
- Dominant language
- Python
- Stars
- 20
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
Detailed Description
Add documentation for what is inside samples.
Context
- samples are sometimes dict (or dicts) of arrays, and the sarray might represent (C, T, W, H)
- site samples, dont need it, as they are xarray objects
Possible Implementation
- a documentation of what it is in sample, perhaps a readme me here
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 inspecting the sample directory at ocf_data_sampler/torch_datasets/sample and identify how samples are represented. Document dict or dict-of-array samples, including the possible (C, T, W, H) shape, and note that site samples are xarray objects and do not need this documentation. Done means the sample contents and exceptions are clearly described in a README or equivalent documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100