add python sdk doc

star-whale · Oct 9, 2022 · 6010384 · 6010384
1 parent dc6e6fd
commit 6010384
Show file tree

Hide file tree

Showing 15 changed files with 1,070 additions and 13 deletions.
diff --git a/client/starwhale/__init__.py b/client/starwhale/__init__.py
@@ -1,5 +1,6 @@
 from starwhale.api.job import step, Context
 from starwhale.version import STARWHALE_VERSION as __version__
+from starwhale.base.uri import URI, URIType
 from starwhale.api.model import PipelineHandler, PPLResultIterator
 from starwhale.api.metric import multi_classification
 from starwhale.api.dataset import (
@@ -18,8 +19,6 @@
     get_data_loader,
     LocalFSLinkAuth,
     DefaultS3LinkAuth,
-    SWDSBinDataLoader,
-    UserRawDataLoader,
     COCOObjectAnnotation,
     SWDSBinBuildExecutor,
     UserRawBuildExecutor,
@@ -29,6 +28,8 @@
     "__version__",
     "PipelineHandler",
     "multi_classification",
+    "URI",
+    "URIType",
     "step",
     "Context",
     "get_data_loader",
@@ -41,8 +42,6 @@
     "BuildExecutor",  # SWDSBinBuildExecutor alias
     "UserRawBuildExecutor",
     "SWDSBinBuildExecutor",
-    "SWDSBinDataLoader",
-    "UserRawDataLoader",
     "Binary",
     "Text",
     "Audio",

diff --git a/client/tests/sdk/test_loader.py b/client/tests/sdk/test_loader.py
@@ -4,13 +4,7 @@
 
 from pyfakefs.fake_filesystem_unittest import TestCase
 
-from starwhale import (
-    MIMEType,
-    S3LinkAuth,
-    get_data_loader,
-    SWDSBinDataLoader,
-    UserRawDataLoader,
-)
+from starwhale import MIMEType, S3LinkAuth, get_data_loader
 from starwhale.consts import AUTH_ENV_FNAME, SWDSBackendType
 from starwhale.base.uri import URI
 from starwhale.utils.fs import ensure_dir, ensure_file
@@ -22,6 +16,7 @@
     LocalFSStorageBackend,
 )
 from starwhale.core.dataset.tabular import TabularDatasetRow
+from starwhale.api._impl.dataset.loader import SWDSBinDataLoader, UserRawDataLoader
 
 from .. import ROOT_DIR
 

diff --git a/client/tests/sdk/test_model.py b/client/tests/sdk/test_model.py
@@ -7,7 +7,7 @@
 
 from pyfakefs.fake_filesystem_unittest import TestCase
 
-from starwhale import Context, get_data_loader, PipelineHandler, UserRawDataLoader
+from starwhale import Context, get_data_loader, PipelineHandler
 from starwhale.consts import DEFAULT_PROJECT
 from starwhale.base.uri import URI
 from starwhale.utils.fs import ensure_dir
@@ -22,6 +22,7 @@
 from starwhale.core.dataset.type import MIMEType, ArtifactType, DatasetSummary
 from starwhale.core.dataset.store import DatasetStorage
 from starwhale.core.dataset.tabular import TabularDatasetRow
+from starwhale.api._impl.dataset.loader import UserRawDataLoader
 
 from .. import ROOT_DIR
 

diff --git a/docs/docs/reference/sdk/data_type.md b/docs/docs/reference/sdk/data_type.md
@@ -0,0 +1,3 @@
+---
+title: Data Type
+---
diff --git a/docs/docs/reference/sdk/dataset.md b/docs/docs/reference/sdk/dataset.md
@@ -0,0 +1,3 @@
+---
+title: Dataset Builder and Loader
+---
diff --git a/docs/docs/reference/sdk/evaluation.md b/docs/docs/reference/sdk/evaluation.md
@@ -0,0 +1,3 @@
+---
+title: Model Evaluation
+---
diff --git a/docs/docs/reference/sdk/other.md b/docs/docs/reference/sdk/other.md
@@ -0,0 +1,3 @@
+---
+title: Other
+---
diff --git a/docs/docs/reference/sdk/overview.md b/docs/docs/reference/sdk/overview.md
@@ -0,0 +1,3 @@
+---
+title: Python SDK
+---
diff --git a/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/model.md b/docs/i18n/zh/docusaurus-plugin-content-docs/current/reference/cli/model.md
@@ -14,7 +14,7 @@ model命令提供适用于Standalone Instance和Cloud Instance的Starwhale Model
 
 model包含如下子命令：
 
-|Command|Standalone|Cloud|
+|命令|Standalone|Cloud|
 |-------|----------|-----|
 |`build`|✅|❌|
 |`copy`|✅|✅|