| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="../"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>Helper Classes — datasketches 0.1 documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="../_static/jquery.js?v=5d32c60e"></script> |
| <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="../_static/documentation_options.js?v=2709fde1"></script> |
| <script src="../_static/doctools.js?v=9bcbadda"></script> |
| <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="../_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="Serialize/Deserialize (SerDe)" href="serde.html" /> |
| <link rel="prev" title="Exact and Bounded, Probabilitiy Proportional to Size (EBPPS) Sampling" href="../sampling/ebpps.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../index.html" class="icon icon-home"> |
| datasketches |
| </a> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../distinct_counting/index.html">Distinct Counting</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../quantiles/index.html">Quantiles Sketches</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../frequency/index.html">Frequency Sketches</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../vector/index.html">Vector Sketches</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../sampling/index.html">Random Sampling Sketches</a></li> |
| </ul> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Helper Classes</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="serde.html">Serialize/Deserialize (SerDe)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="jaccard.html">Jaccard Similarity</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tuple_policy.html">Tuple Policy</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ks_test.html">Kolmogorov-Smirnov Test</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="kernel.html">Kernel Function</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">datasketches</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item active">Helper Classes</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="../_sources/helper/index.rst.txt" rel="nofollow"> View page source</a> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <section id="helper-classes"> |
| <h1>Helper Classes<a class="headerlink" href="#helper-classes" title="Link to this heading"></a></h1> |
| <p>These classes are required for certain sketches or specific |
| functionality within sketches. |
| Some of them are abstract base classes, but in those cases there is at |
| least one reference example of a concrete class.</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">serde</span></code> is used when serializing and deserializing sketches.</p></li> |
| <li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">jaccard</span></code> is used to compute the Jaccard similarity between pairs of theta or tuple sketches.</p></li> |
| <li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple_policy</span></code> is required to use a <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple_sketch</span></code> by specifying how summaries are combined.</p></li> |
| <li><p><code class="xref py py-func docutils literal notranslate"><span class="pre">ks_test()</span></code> performs a Kolmogorov-Smirnov test on absolute-error quantiles family sketches.</p></li> |
| <li><p><code class="xref py py-class docutils literal notranslate"><span class="pre">kernel_function</span></code> is required when using a <code class="xref py py-class docutils literal notranslate"><span class="pre">kernel_sketch</span></code> for Kernel Density Estimation.</p></li> |
| </ul> |
| </div></blockquote> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="serde.html">Serialize/Deserialize (SerDe)</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="jaccard.html">Jaccard Similarity</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="tuple_policy.html">Tuple Policy</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="ks_test.html">Kolmogorov-Smirnov Test</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="kernel.html">Kernel Function</a></li> |
| </ul> |
| </div> |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="../sampling/ebpps.html" class="btn btn-neutral float-left" title="Exact and Bounded, Probabilitiy Proportional to Size (EBPPS) Sampling" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="serde.html" class="btn btn-neutral float-right" title="Serialize/Deserialize (SerDe)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright 2023.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
