Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added tuple and density to docs #7

Merged
merged 1 commit into from
Sep 12, 2023
Merged

Added tuple and density to docs #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
Expand Down
8 changes: 8 additions & 0 deletions docs/source/density_sketch.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Density Sketch
--------------
.. autoclass:: datasketches.density_sketch
:members:
:undoc-members:

.. autoclass:: datasketches.GaussianKernel
:members:
8 changes: 8 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ Counting Distincts
hyper_log_log
cpc
theta
tuple

Density Sketch
##############
.. toctree::
:maxdepth: 1

density_sketch

Frequency Estimation
##########################
Expand Down
15 changes: 15 additions & 0 deletions docs/source/tuple.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: