tensorflow / tensorflow/datasets
Document `beam_pipeline_options`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.6k
- Forks
- 1.6k
- Avg merge
- 3h 54m
- Merged PRs (30d)
- 1
Description
Description of issue
It is not clear to me from the documentation what inputs are valid for the tfds build --beam_pipeline_options flag. In particular, I am interested in figuring out how to execute the build in a Docker container per https://beam.apache.org/documentation/runtime/environments/#custom-containers (perhaps this should be a separate issue).
I am happy to submit a PR, but I don't know the answer to my own question.
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 with the tfds build --beam_pipeline_options entry point and the linked Apache Beam custom-container documentation. Determine which inputs the flag accepts and how Docker container execution is configured, then document those valid inputs and usage examples; mark the container guidance separately if it needs a new issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100