Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions python/docs/cli/dataset.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Dataset
+++++++

.. lightning-reference:: dataset
:root-label: lightning dataset
:anchor-prefix: dataset

from lightning_sdk.cli.groups import dataset
2 changes: 2 additions & 0 deletions python/docs/cli/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Common Workflows
* Submit and inspect training or batch work with :doc:`job` and :doc:`mmt`.
* Build and operate inference services with :doc:`deployment` and :doc:`model`.
* Move data and artifacts with :doc:`file`, :doc:`folder`, :doc:`container`, and :doc:`cp`.
* Upload and download versioned datasets with :doc:`dataset`.
* Configure accounts, organizations, teamspaces, cloud accounts, and SSH with
:doc:`config`, :doc:`api-key`, and :doc:`ssh`.
* Manage lower-level sandbox sessions with :doc:`sandbox`.
Expand All @@ -84,6 +85,7 @@ reference.
api-key
file
folder
dataset
ssh
studio
sandbox
Expand Down
1 change: 1 addition & 0 deletions python/docs/sdk/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,5 @@ Reference Pages
api/user
api/status
api/models
api/datasets
api/experiment
17 changes: 17 additions & 0 deletions python/docs/sdk/api/datasets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Datasets
========

Download and upload datasets programmatically. These are the Python
equivalents of the ``lightning dataset`` CLI commands.

.. currentmodule:: lightning_sdk.datasets

.. autofunction:: download_dataset

.. autofunction:: upload_dataset

.. autoclass:: DownloadedDatasetInfo
:members:

.. autoclass:: UploadedDatasetInfo
:members:
Loading