From d8ff9243f9c540c98a0ffcaf824d0feb97457315 Mon Sep 17 00:00:00 2001 From: Katharine Xiao <2405771+katxiao@users.noreply.github.com> Date: Thu, 24 Mar 2022 11:05:59 -0700 Subject: [PATCH] Add sampling API to docs (#742) --- .gitignore | 2 ++ docs/.DS_Store | Bin 6148 -> 0 bytes docs/api_reference/index.rst | 1 + docs/api_reference/sampling/index.rst | 10 ++++++++++ docs/api_reference/sampling/tabular.rst | 16 ++++++++++++++++ 5 files changed, 29 insertions(+) delete mode 100644 docs/.DS_Store create mode 100644 docs/api_reference/sampling/index.rst create mode 100644 docs/api_reference/sampling/tabular.rst diff --git a/.gitignore b/.gitignore index 1bf92b0b5..dcbbb4e0b 100644 --- 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 deleted file mode 100644 index f940bed6e384f5f76cd23313e2f8236eb972bc2c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKI|>3Z5S>vG!N$@uSMUZw^aLJ2(QSkU3$fqIb9pr1d;e&iX;6Vd)od{|=!lohtBGA;&_%QP(7ai*Ls7pS=NC^Gt$`e=02O#vU>M7p)&Dj8 zP5=K);))7Tfxl8fN2|?hi6>=k?LE$FZGrFLmUDxfVeS+RUXFoYjlb| WP3!`lj=0l-{24G^XjI_a3fut+K^1ra diff --git a/docs/api_reference/index.rst b/docs/api_reference/index.rst index 725be0f2d..29185f2fb 100644 --- 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 new file mode 100644 index 000000000..915bd34c9 --- /dev/null +++ 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 new file mode 100644 index 000000000..c20a6d102 --- /dev/null +++ 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