Skip to content

Commit

Permalink
Deploying to gh-pages from @ d682e55 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Jan 31, 2024
1 parent 1616add commit a7ffbbc
Show file tree
Hide file tree
Showing 31 changed files with 1,260 additions and 5,000 deletions.
2,056 changes: 239 additions & 1,817 deletions _sources/autoapi/arkouda/index.rst.txt

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions autoapi/arkouda/categorical/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">#<
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>values</strong> (<a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – String values to convert to categories</p></li>
<li><p><strong>values</strong> (<a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – String values to convert to categories</p></li>
<li><p><strong>NAvalue</strong> (<em>str scalar</em>) – The value to use to represent missing/null data</p></li>
</ul>
</dd>
Expand All @@ -316,7 +316,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">#<
<dd><p>The set of category labels (determined automatically)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="../index.html#id897" title="arkouda.Strings">Strings</a></p>
<dd class="field-odd"><p><a class="reference internal" href="../index.html#id675" title="arkouda.Strings">Strings</a></p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -443,7 +443,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">#<
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>codes</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><em>int64</em>) – Category indices of each value</p></li>
<li><p><strong>categories</strong> (<a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – Unique category labels</p></li>
<li><p><strong>categories</strong> (<a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – Unique category labels</p></li>
<li><p><strong>permutation</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><em>int64</em>) – The permutation that groups the values in the same order
as categories</p></li>
<li><p><strong>segments</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><em>int64</em>) – When values are grouped, the starting offset of each group</p></li>
Expand Down Expand Up @@ -497,7 +497,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">#<
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>new_categories</strong> (<a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – The array of new categories to use. Must be unique.</p></li>
<li><p><strong>new_categories</strong> (<a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – The array of new categories to use. Must be unique.</p></li>
<li><p><strong>NAvalue</strong> (<em>str scalar</em>) – The value to use to represent missing/null data</p></li>
</ul>
</dd>
Expand Down Expand Up @@ -708,7 +708,7 @@ <h3>Classes<a class="headerlink" href="#classes" title="Link to this heading">#<
where an element of <cite>self</cite> is in <cite>test</cite> and False otherwise.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>test</strong> (<em>Union</em><em>[</em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a><em>,</em><a class="reference internal" href="#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical"><em>Categorical</em></a><em>]</em>) – The values against which to test each value of ‘self`.</p>
<dd class="field-odd"><p><strong>test</strong> (<em>Union</em><em>[</em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a><em>,</em><a class="reference internal" href="#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical"><em>Categorical</em></a><em>]</em>) – The values against which to test each value of ‘self`.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The values <cite>self[in1d]</cite> are in the <cite>test</cite> Strings or Categorical object.</p>
Expand Down
2 changes: 1 addition & 1 deletion autoapi/arkouda/client_dtypes/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>values</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em> or </em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – The array of field values. If (u)int64, the values are used as-is for the
<li><p><strong>values</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em> or </em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – The array of field values. If (u)int64, the values are used as-is for the
binary representation of fields. If Strings, the values are converted
to binary according to the mapping defined by the names and MSB_left
arguments.</p></li>
Expand Down
4 changes: 2 additions & 2 deletions autoapi/arkouda/dataframe/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -330,8 +330,8 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
<li><p><strong>initialdata</strong> (<em>List</em><em> or </em><em>dictionary</em><em> of </em><em>lists</em><em>, </em><em>tuples</em><em>, or </em><em>pdarrays</em>) – Each list/dictionary entry corresponds to one column of the data and
should be a homogenous type. Different columns may have different
types. If using a dictionary, keys should be strings.</p></li>
<li><p><strong>index</strong> (<a class="reference internal" href="../../../usage/Index.html#arkouda.Index" title="arkouda.Index"><em>Index</em></a><em>, </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, or </em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – Index for the resulting frame. Defaults to an integer range.</p></li>
<li><p><strong>columns</strong> (<em>List</em><em>, </em><em>tuple</em><em>, </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, or </em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – Column labels to use if the data does not include them. Elements must
<li><p><strong>index</strong> (<a class="reference internal" href="../../../usage/Index.html#arkouda.Index" title="arkouda.Index"><em>Index</em></a><em>, </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, or </em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – Index for the resulting frame. Defaults to an integer range.</p></li>
<li><p><strong>columns</strong> (<em>List</em><em>, </em><em>tuple</em><em>, </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, or </em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – Column labels to use if the data does not include them. Elements must
be strings. Defaults to an stringified integer range.</p></li>
</ul>
</dd>
Expand Down
14 changes: 7 additions & 7 deletions autoapi/arkouda/groupbyclass/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>pda</strong> (<em>(</em><em>list of</em><em>) </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a><em>, or </em><a class="reference internal" href="../categorical/index.html#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical"><em>Categorical</em></a>) – Input array.</p></li>
<li><p><strong>pda</strong> (<em>(</em><em>list of</em><em>) </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a><em>, or </em><a class="reference internal" href="../categorical/index.html#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical"><em>Categorical</em></a>) – Input array.</p></li>
<li><p><strong>return_groups</strong> (<em>bool</em><em>, </em><em>optional</em>) – If True, also return grouping information for the array.</p></li>
<li><p><strong>return_indices</strong> (<em>bool</em><em>, </em><em>optional</em>) – Only applicable if return_groups is True.
If True, return unique key indices along with other groups</p></li>
Expand Down Expand Up @@ -379,7 +379,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>keys</strong> (<em>(</em><em>list of</em><em>) </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a><em>, or </em><a class="reference internal" href="../categorical/index.html#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical"><em>Categorical</em></a>) – The array to group by value, or if list, the column arrays to group by row</p></li>
<li><p><strong>keys</strong> (<em>(</em><em>list of</em><em>) </em><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a><em>, or </em><a class="reference internal" href="../categorical/index.html#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical"><em>Categorical</em></a>) – The array to group by value, or if list, the column arrays to group by row</p></li>
<li><p><strong>assume_sorted</strong> (<em>bool</em>) – If True, assume keys is already sorted (Default: False)</p></li>
</ul>
</dd>
Expand Down Expand Up @@ -423,7 +423,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<dd><p>The unique values of the keys array(s), in grouped order</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>(list of) <a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray">pdarray</a>, <a class="reference internal" href="../index.html#id897" title="arkouda.Strings">Strings</a>, or <a class="reference internal" href="../categorical/index.html#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical">Categorical</a></p>
<dd class="field-odd"><p>(list of) <a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray">pdarray</a>, <a class="reference internal" href="../index.html#id675" title="arkouda.Strings">Strings</a>, or <a class="reference internal" href="../categorical/index.html#arkouda.categorical.Categorical" title="arkouda.categorical.Categorical">Categorical</a></p>
</dd>
</dl>
</dd></dl>
Expand Down Expand Up @@ -1393,7 +1393,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>values</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – The values to put in each group’s segment</p></li>
<li><p><strong>values</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – The values to put in each group’s segment</p></li>
<li><p><strong>permute</strong> (<em>bool</em>) – If True (default), permute broadcast values back to the ordering
of the original array on which GroupBy was called. If False, the
broadcast values are grouped by value.</p></li>
Expand All @@ -1403,7 +1403,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<dd class="field-even"><p>The broadcasted values</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray">pdarray</a>, <a class="reference internal" href="../index.html#id897" title="arkouda.Strings">Strings</a></p>
<dd class="field-odd"><p><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray">pdarray</a>, <a class="reference internal" href="../index.html#id675" title="arkouda.Strings">Strings</a></p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
Expand Down Expand Up @@ -1607,7 +1607,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<dd class="field-odd"><ul class="simple">
<li><p><strong>segments</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><em>int64</em>) – Offsets of the start of each row in the sparse matrix or grouped array.
Must be sorted in ascending order.</p></li>
<li><p><strong>values</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id897" title="arkouda.Strings"><em>Strings</em></a>) – The values to broadcast, one per row (or group)</p></li>
<li><p><strong>values</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><a class="reference internal" href="../index.html#id675" title="arkouda.Strings"><em>Strings</em></a>) – The values to broadcast, one per row (or group)</p></li>
<li><p><strong>size</strong> (<em>int</em>) – The total number of nonzeros in the matrix. If permutation is given, this
argument is ignored and the size is inferred from the permutation array.</p></li>
<li><p><strong>permutation</strong> (<a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray"><em>pdarray</em></a><em>, </em><em>int64</em>) – The permutation to go from the original ordering of nonzeros to the ordering
Expand All @@ -1621,7 +1621,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
<dd class="field-even"><p>The broadcast values, one per nonzero</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray">pdarray</a>, <a class="reference internal" href="../index.html#id897" title="arkouda.Strings">Strings</a></p>
<dd class="field-odd"><p><a class="reference internal" href="../../../usage/pdarray.html#arkouda.pdarray" title="arkouda.pdarray">pdarray</a>, <a class="reference internal" href="../index.html#id675" title="arkouda.Strings">Strings</a></p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>ValueError</strong><ul class="simple">
Expand Down
Loading

0 comments on commit a7ffbbc

Please sign in to comment.