Add sampling API to docs (#742)

sdv-dev · Mar 24, 2022 · d8ff924 · d8ff924
1 parent 4232f12
commit d8ff924
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -106,6 +106,8 @@ ENV/
 # Vim
 .*.swp
 
+# other
+.DS_Store
 sdv/data/
 docs/**/*.pkl
 docs/**/*metadata.json

diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/api_reference/index.rst b/docs/api_reference/index.rst
@@ -15,6 +15,7 @@ and classes in SDV.
    timeseries/index
    metadata/index
    constraints/index
+   sampling/index
    metrics/index
    evaluation
    demo
diff --git a/docs/api_reference/sampling/index.rst b/docs/api_reference/sampling/index.rst
@@ -0,0 +1,10 @@
+.. _sdv.sampling:
+
+sdv.sampling
+===============
+
+.. toctree::
+    :maxdepth: 1
+    :titlesonly:
+
+    tabular
diff --git a/docs/api_reference/sampling/tabular.rst b/docs/api_reference/sampling/tabular.rst
@@ -0,0 +1,16 @@
+.. _sdv.sampling.tabular:
+
+Tabular Conditions
+===================
+
+.. currentmodule:: sdv.sampling
+
+Condition
+~~~~~~~~~
+
+.. autosummary::
+   :toctree: api/
+
+   Condition
+   Condition.get_column_values
+   Condition.get_num_rows