Add Python training dataset API reference (#215)

logicalclocks · Jan 13, 2021 · b2a7e0b · b2a7e0b
1 parent 880366e
commit b2a7e0b
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 0 deletions.
diff --git a/auto_doc.py b/auto_doc.py
@@ -102,6 +102,17 @@
         ),
         "fg_methods": keras_autodoc.get_methods("hsfs.feature_group.FeatureGroup"),
     },
+    "api/training_dataset_api.md": {
+        "td": ["hsfs.training_dataset.TrainingDataset"],
+        "td_create": ["hsfs.feature_store.FeatureStore.create_training_dataset"],
+        "td_get": ["hsfs.feature_store.FeatureStore.get_training_dataset"],
+        "td_properties": keras_autodoc.get_properties(
+            "hsfs.training_dataset.TrainingDataset"
+        ),
+        "td_methods": keras_autodoc.get_methods(
+            "hsfs.training_dataset.TrainingDataset"
+        ),
+    },
     "api/feature_api.md": {
         "feature": ["hsfs.feature.Feature"],
         "feature_properties": keras_autodoc.get_properties("hsfs.feature.Feature"),

diff --git a/docs/templates/api/training_dataset_api.md b/docs/templates/api/training_dataset_api.md
@@ -0,0 +1,19 @@
+# Training Dataset
+
+{{td}}
+
+## Creation
+
+{{td_create}}
+
+## Retrieval
+
+{{td_get}}
+
+## Properties
+
+{{td_properties}}
+
+## Methods
+
+{{td_methods}}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -57,6 +57,7 @@ nav:
     - Connection: generated/api/connection_api.md
     - FeatureStore: generated/api/feature_store_api.md
     - FeatureGroup: generated/api/feature_group_api.md
+    - TrainingDataset: generated/api/training_dataset_api.md
     - Storage Connector: generated/api/storage_connector_api.md
     - Feature: generated/api/feature_api.md
   - Contributing: CONTRIBUTING.md