Skip to content

Commit 9789937

Browse files
committed
1 parent 7403202 commit 9789937

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

docs/dev/generated/skbio.stats.isubsample.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -698,7 +698,7 @@
698698
<h1>skbio.stats.isubsample<a class="headerlink" href="#skbio-stats-isubsample" title="Link to this heading">#</a></h1>
699699
<dl class="py function">
700700
<dt class="sig sig-object py" id="skbio.stats.isubsample">
701-
<span class="sig-prename descclassname"><span class="pre">skbio.stats.</span></span><span class="sig-name descname"><span class="pre">isubsample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimum</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buf_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bin_f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/_subsample.py#L19"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.isubsample" title="Link to this definition">#</a></dt>
701+
<span class="sig-prename descclassname"><span class="pre">skbio.stats.</span></span><span class="sig-name descname"><span class="pre">isubsample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">items</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maximum</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minimum</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">buf_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1000</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bin_f</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/_subsample.py#L21"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.isubsample" title="Link to this definition">#</a></dt>
702702
<dd><p>Randomly subsample items from bins, without replacement.</p>
703703
<p>Randomly subsample items without replacement from an unknown number of
704704
input items, that may fall into an unknown number of bins. This method is

docs/dev/generated/skbio.stats.subsample_counts.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -698,19 +698,21 @@
698698
<h1>skbio.stats.subsample_counts<a class="headerlink" href="#skbio-stats-subsample-counts" title="Link to this heading">#</a></h1>
699699
<dl class="py function">
700700
<dt class="sig sig-object py" id="skbio.stats.subsample_counts">
701-
<span class="sig-prename descclassname"><span class="pre">skbio.stats.</span></span><span class="sig-name descname"><span class="pre">subsample_counts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">counts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/_subsample.py#L150"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.subsample_counts" title="Link to this definition">#</a></dt>
701+
<span class="sig-prename descclassname"><span class="pre">skbio.stats.</span></span><span class="sig-name descname"><span class="pre">subsample_counts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">counts</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">seed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/stats/_subsample.py#L152"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.stats.subsample_counts" title="Link to this definition">#</a></dt>
702702
<dd><p>Randomly subsample from a vector of counts, with or without replacement.</p>
703703
<dl class="field-list simple">
704704
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
705705
<dd class="field-odd"><dl class="simple">
706-
<dt><strong>counts</strong><span class="classifier">1-D array_like</span></dt><dd><p>Vector of counts (integers) to randomly subsample from.</p>
706+
<dt><strong>counts</strong><span class="classifier">1-D array_like</span></dt><dd><p>Vector of counts (integers or floats) to randomly subsample from.</p>
707707
</dd>
708708
<dt><strong>n</strong><span class="classifier">int</span></dt><dd><p>Number of items to subsample from <cite>counts</cite>. Must be less than or equal
709709
to the sum of <cite>counts</cite>.</p>
710710
</dd>
711711
<dt><strong>replace</strong><span class="classifier">bool, optional</span></dt><dd><p>If <code class="docutils literal notranslate"><span class="pre">True</span></code>, subsample with replacement. If <code class="docutils literal notranslate"><span class="pre">False</span></code> (the default),
712712
subsample without replacement.</p>
713713
</dd>
714+
<dt><strong>seed</strong><span class="classifier">int or np.random.Generator, optional</span></dt><dd><p>A user-provided random seed or random generator instance.</p>
715+
</dd>
714716
</dl>
715717
</dd>
716718
<dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -723,8 +725,6 @@ <h1>skbio.stats.subsample_counts<a class="headerlink" href="#skbio-stats-subsamp
723725
</dd>
724726
<dt class="field-odd">Raises<span class="colon">:</span></dt>
725727
<dd class="field-odd"><dl class="simple">
726-
<dt>TypeError</dt><dd><p>If <cite>counts</cite> cannot be safely converted to an integer datatype.</p>
727-
</dd>
728728
<dt>ValueError</dt><dd><p>If <cite>n</cite> is less than zero or greater than the sum of <cite>counts</cite>
729729
when <cite>replace=False</cite>.</p>
730730
</dd>

docs/dev/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/dev/stats.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -735,7 +735,7 @@ <h2>Composition statistics<a class="headerlink" href="#composition-statistics" t
735735
<h2>Data subsampling<a class="headerlink" href="#data-subsampling" title="Link to this heading">#</a></h2>
736736
<div class="pst-scrollable-table-container"><table class="autosummary longtable table autosummary">
737737
<tbody>
738-
<tr class="row-odd"><td><p><a class="reference internal" href="generated/skbio.stats.subsample_counts.html#skbio.stats.subsample_counts" title="skbio.stats.subsample_counts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subsample_counts</span></code></a>(counts, n[, replace])</p></td>
738+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/skbio.stats.subsample_counts.html#skbio.stats.subsample_counts" title="skbio.stats.subsample_counts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subsample_counts</span></code></a>(counts, n[, replace, seed])</p></td>
739739
<td><p>Randomly subsample from a vector of counts, with or without replacement.</p></td>
740740
</tr>
741741
<tr class="row-even"><td><p><a class="reference internal" href="generated/skbio.stats.isubsample.html#skbio.stats.isubsample" title="skbio.stats.isubsample"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isubsample</span></code></a>(items, maximum[, minimum, ...])</p></td>

0 commit comments

Comments
 (0)