microsoft / microsoft/planetary-computer-tasks

Add more examples of splits in dataset configurations.

Open
#189 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
43
Forks
19
Avg merge
1h 23m
Merged PRs (30d)
1

Description

The documentation should include examples of all supported split configurations. For example, how does one get the glob equivalent of v002/*/2021/, splitting by state (the *) for NAIP data?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the user guide's chunking page at the Splits section and review the existing dataset-configuration examples and supported split forms. Add examples covering all supported configurations, including the glob-equivalent case for v002/*/2021/ and splitting NAIP data by state; done means readers can map each form to a concrete configuration.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.