diff --git a/python/docs/cli/dataset.rst b/python/docs/cli/dataset.rst new file mode 100644 index 00000000..8cb15c34 --- /dev/null +++ b/python/docs/cli/dataset.rst @@ -0,0 +1,8 @@ +Dataset ++++++++ + +.. lightning-reference:: dataset + :root-label: lightning dataset + :anchor-prefix: dataset + + from lightning_sdk.cli.groups import dataset diff --git a/python/docs/cli/index.rst b/python/docs/cli/index.rst index 6b864f4d..7c61b654 100644 --- a/python/docs/cli/index.rst +++ b/python/docs/cli/index.rst @@ -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`. @@ -84,6 +85,7 @@ reference. api-key file folder + dataset ssh studio sandbox diff --git a/python/docs/sdk/api.rst b/python/docs/sdk/api.rst index 9128dd46..6ef219fc 100644 --- a/python/docs/sdk/api.rst +++ b/python/docs/sdk/api.rst @@ -86,4 +86,5 @@ Reference Pages api/user api/status api/models + api/datasets api/experiment diff --git a/python/docs/sdk/api/datasets.rst b/python/docs/sdk/api/datasets.rst new file mode 100644 index 00000000..7de0cd8f --- /dev/null +++ b/python/docs/sdk/api/datasets.rst @@ -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: