docs(sdk): document the dataset CLI and Python API#27
Draft
ravivooda wants to merge 1 commit into
Draft
Conversation
Add a CLI reference page for the `lightning dataset` group (download / upload) and an SDK API page for lightning_sdk.datasets (download_dataset / upload_dataset and their *Info return types), mirroring how `model` / `models` are documented. Both pages auto-generate from the code, so they track the as_zip / worker-tuning changes as those land. Wire both into their toctrees and add a CLI workflow bullet. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds user-facing docs for the dataset feature, mirroring how
model/modelsare documented:docs/cli/dataset.rst— CLI reference for thelightning datasetgroup (download / upload), via thelightning-referencedirective. Wired intodocs/cli/index.rsttoctree + a workflow bullet.docs/sdk/api/datasets.rst— SDK API page forlightning_sdk.datasets(download_dataset,upload_dataset, and the*Inforeturn types). Wired into thedocs/sdk/api.rsttoctree.Why
download_dataset/upload_datasetand thelightning datasetCLI had no documentation anywhere.Notes
as_zipand worker-tuning changes as those land — no prose to keep in sync.lightning --helptable once feat(cli): expose the dataset command group #26 lands.🤖 Generated with Claude Code