This is an automated email from the ASF dual-hosted git repository. charlie pushed a commit to branch docs-update in repository https://gitbox.apache.org/repos/asf/datasketches-python.git
commit 044c93db3123f1605224f4ff4e0f56a7dbbb2bfc Author: Charlie Dickens <[email protected]> AuthorDate: Tue Sep 12 10:29:00 2023 +0100 Added tuple and density to docs --- docs/source/conf.py | 1 + docs/source/density_sketch.rst | 8 ++++++++ docs/source/index.rst | 8 ++++++++ docs/source/tuple.rst | 15 +++++++++++++++ 4 files changed, 32 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 508aed7..75a3f4a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -8,6 +8,7 @@ import sys import os +import datasketches # need to fix the paths so that sphinx can find the source code. sys.path.insert(0, os.path.abspath("../../datasketches")) diff --git a/docs/source/density_sketch.rst b/docs/source/density_sketch.rst new file mode 100644 index 0000000..2aa0eb4 --- /dev/null +++ b/docs/source/density_sketch.rst @@ -0,0 +1,8 @@ +Density Sketch +-------------- +.. autoclass:: datasketches.density_sketch + :members: + :undoc-members: + +.. autoclass:: datasketches.GaussianKernel + :members: \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 9e3c47b..b6998c2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -19,6 +19,14 @@ Counting Distincts hyper_log_log cpc theta + tuple + +Density Sketch +############## +.. toctree:: + :maxdepth: 1 + + density_sketch Frequency Estimation ########################## diff --git a/docs/source/tuple.rst b/docs/source/tuple.rst new file mode 100644 index 0000000..2b5323c --- /dev/null +++ b/docs/source/tuple.rst @@ -0,0 +1,15 @@ +Tuple Sketch +------------ + +.. autoclass:: datasketches.tuple_sketch + :members: + :undoc-members: + +.. autoclass:: datasketches.AccumulatorPolicy + :members: + +.. autoclass:: datasketches.MaxIntPolicy + :members: + +.. autoclass:: datasketches.MinIntPolicy + :members: \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
