Skip to content

Commit aba2f35

Browse files
shssfshssf
committed
update documentation
1 parent 073edaa commit aba2f35

File tree

220 files changed

+19315
-677
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

220 files changed

+19315
-677
lines changed

‎doc/contents.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@ Contents
88
:caption: Contents:
99

1010
About dpnp <index>
11-
Numpy API <numpy_api>
11+
DPNP API <dpnp_api>
12+
DPNP C++ backend API <dpnp_backend_api>

‎doc/numpy_api.rst renamed to ‎doc/dpnp_api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _numpy_api:
1+
.. _dpnp_api:
22

33
###############
4-
Numpy Functions
4+
DPNP API Functions
55
###############
66

77
.. automodule:: dpnp

‎doc/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
.. _index:
22

33
###########
4-
Intel Numpy
4+
DPNP
55
###########
6-
Subclass of numpy.ndarray that uses mkl_malloc
7-
6+
NumPy-like API accelerated with SYCL

‎docs/_modules/dpnp/dpnp_iface.html

Lines changed: 13 additions & 92 deletions
Large diffs are not rendered by default.

‎docs/_modules/dpnp/dpnp_iface_arraycreation.html

Lines changed: 14 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/_modules/dpnp/dpnp_iface_bitwise.html

Lines changed: 516 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_modules/dpnp/dpnp_iface_counting.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@
8888
<p class="caption"><span class="caption-text">Contents:</span></p>
8989
<ul>
9090
<li class="toctree-l1"><a class="reference internal" href="../../index.html">About dpnp</a></li>
91-
<li class="toctree-l1"><a class="reference internal" href="../../numpy_api.html">Numpy API</a></li>
91+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_api.html">DPNP API</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_backend_api.html">DPNP C++ backend API</a></li>
9293
</ul>
9394

9495

@@ -199,14 +200,14 @@ <h1>Source code for dpnp.dpnp_iface_counting</h1><div class="highlight"><pre>
199200

200201
<span class="kn">from</span> <span class="nn">dpnp.backend</span> <span class="kn">import</span> <span class="o">*</span>
201202
<span class="kn">from</span> <span class="nn">dpnp.dparray</span> <span class="kn">import</span> <span class="n">dparray</span>
202-
<span class="kn">from</span> <span class="nn">dpnp.dpnp_utils</span> <span class="kn">import</span> <span class="n">checker_throw_value_error</span><span class="p">,</span> <span class="n">use_origin_backend</span>
203+
<span class="kn">from</span> <span class="nn">dpnp.dpnp_utils</span> <span class="kn">import</span> <span class="o">*</span>
203204

204205
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
205206
<span class="s1">&#39;count_nonzero&#39;</span>
206207
<span class="p">]</span>
207208

208209

209-
<div class="viewcode-block" id="count_nonzero"><a class="viewcode-back" href="../../numpy_api.html#dpnp.count_nonzero">[docs]</a><span class="k">def</span> <span class="nf">count_nonzero</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">keepdims</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
210+
<div class="viewcode-block" id="count_nonzero"><a class="viewcode-back" href="../../dpnp_api.html#dpnp.count_nonzero">[docs]</a><span class="k">def</span> <span class="nf">count_nonzero</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">keepdims</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
210211
<span class="sd">&quot;&quot;&quot;</span>
211212
<span class="sd"> Counts the number of non-zero values in the array ``a``.</span>
212213

‎docs/_modules/dpnp/dpnp_iface_libmath.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@
8888
<p class="caption"><span class="caption-text">Contents:</span></p>
8989
<ul>
9090
<li class="toctree-l1"><a class="reference internal" href="../../index.html">About dpnp</a></li>
91-
<li class="toctree-l1"><a class="reference internal" href="../../numpy_api.html">Numpy API</a></li>
91+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_api.html">DPNP API</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_backend_api.html">DPNP C++ backend API</a></li>
9293
</ul>
9394

9495

@@ -205,7 +206,7 @@ <h1>Source code for dpnp.dpnp_iface_libmath</h1><div class="highlight"><pre>
205206
<span class="p">]</span>
206207

207208

208-
<div class="viewcode-block" id="erf"><a class="viewcode-back" href="../../numpy_api.html#dpnp.erf">[docs]</a><span class="k">def</span> <span class="nf">erf</span><span class="p">(</span><span class="n">in_array1</span><span class="p">):</span>
209+
<div class="viewcode-block" id="erf"><a class="viewcode-back" href="../../dpnp_api.html#dpnp.erf">[docs]</a><span class="k">def</span> <span class="nf">erf</span><span class="p">(</span><span class="n">in_array1</span><span class="p">):</span>
209210
<span class="sd">&quot;&quot;&quot;</span>
210211
<span class="sd"> Return the &#39;error function&#39; at in_array1.</span>
211212

‎docs/_modules/dpnp/dpnp_iface_linearalgebra.html

Lines changed: 73 additions & 95 deletions
Large diffs are not rendered by default.

‎docs/_modules/dpnp/dpnp_iface_logic.html

Lines changed: 536 additions & 33 deletions
Large diffs are not rendered by default.

‎docs/_modules/dpnp/dpnp_iface_manipulation.html

Lines changed: 145 additions & 7 deletions
Large diffs are not rendered by default.

‎docs/_modules/dpnp/dpnp_iface_mathematical.html

Lines changed: 341 additions & 139 deletions
Large diffs are not rendered by default.

‎docs/_modules/dpnp/dpnp_iface_searching.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@
8888
<p class="caption"><span class="caption-text">Contents:</span></p>
8989
<ul>
9090
<li class="toctree-l1"><a class="reference internal" href="../../index.html">About dpnp</a></li>
91-
<li class="toctree-l1"><a class="reference internal" href="../../numpy_api.html">Numpy API</a></li>
91+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_api.html">DPNP API</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_backend_api.html">DPNP C++ backend API</a></li>
9293
</ul>
9394

9495

@@ -199,15 +200,16 @@ <h1>Source code for dpnp.dpnp_iface_searching</h1><div class="highlight"><pre>
199200

200201
<span class="kn">from</span> <span class="nn">dpnp.backend</span> <span class="kn">import</span> <span class="o">*</span>
201202
<span class="kn">from</span> <span class="nn">dpnp.dparray</span> <span class="kn">import</span> <span class="n">dparray</span>
202-
<span class="kn">from</span> <span class="nn">dpnp.dpnp_utils</span> <span class="kn">import</span> <span class="n">checker_throw_value_error</span><span class="p">,</span> <span class="n">use_origin_backend</span>
203+
<span class="kn">from</span> <span class="nn">dpnp.dpnp_utils</span> <span class="kn">import</span> <span class="o">*</span>
204+
203205

204206
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
205207
<span class="s1">&#39;argmax&#39;</span><span class="p">,</span>
206208
<span class="s1">&#39;argmin&#39;</span>
207209
<span class="p">]</span>
208210

209211

210-
<div class="viewcode-block" id="argmax"><a class="viewcode-back" href="../../numpy_api.html#dpnp.argmax">[docs]</a><span class="k">def</span> <span class="nf">argmax</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">out</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
212+
<div class="viewcode-block" id="argmax"><a class="viewcode-back" href="../../dpnp_api.html#dpnp.argmax">[docs]</a><span class="k">def</span> <span class="nf">argmax</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">out</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
211213
<span class="sd">&quot;&quot;&quot;</span>
212214
<span class="sd"> Returns the indices of the maximum values along an axis.</span>
213215
<span class="sd"> Parameters</span>
@@ -290,7 +292,7 @@ <h1>Source code for dpnp.dpnp_iface_searching</h1><div class="highlight"><pre>
290292
<span class="k">return</span> <span class="n">numpy</span><span class="o">.</span><span class="n">argmax</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="p">,</span> <span class="n">out</span><span class="p">)</span></div>
291293

292294

293-
<div class="viewcode-block" id="argmin"><a class="viewcode-back" href="../../numpy_api.html#dpnp.argmin">[docs]</a><span class="k">def</span> <span class="nf">argmin</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">out</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
295+
<div class="viewcode-block" id="argmin"><a class="viewcode-back" href="../../dpnp_api.html#dpnp.argmin">[docs]</a><span class="k">def</span> <span class="nf">argmin</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">out</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
294296
<span class="sd">&quot;&quot;&quot;</span>
295297
<span class="sd"> Returns the indices of the minimum values along an axis.</span>
296298
<span class="sd"> Parameters</span>

‎docs/_modules/dpnp/dpnp_iface_sorting.html

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@
8888
<p class="caption"><span class="caption-text">Contents:</span></p>
8989
<ul>
9090
<li class="toctree-l1"><a class="reference internal" href="../../index.html">About dpnp</a></li>
91-
<li class="toctree-l1"><a class="reference internal" href="../../numpy_api.html">Numpy API</a></li>
91+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_api.html">DPNP API</a></li>
92+
<li class="toctree-l1"><a class="reference internal" href="../../dpnp_backend_api.html">DPNP C++ backend API</a></li>
9293
</ul>
9394

9495

@@ -199,15 +200,16 @@ <h1>Source code for dpnp.dpnp_iface_sorting</h1><div class="highlight"><pre>
199200

200201
<span class="kn">from</span> <span class="nn">dpnp.backend</span> <span class="kn">import</span> <span class="o">*</span>
201202
<span class="kn">from</span> <span class="nn">dpnp.dparray</span> <span class="kn">import</span> <span class="n">dparray</span>
202-
<span class="kn">from</span> <span class="nn">dpnp.dpnp_utils</span> <span class="kn">import</span> <span class="n">checker_throw_value_error</span><span class="p">,</span> <span class="n">use_origin_backend</span>
203+
<span class="kn">from</span> <span class="nn">dpnp.dpnp_utils</span> <span class="kn">import</span> <span class="o">*</span>
204+
203205

204206
<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span>
205207
<span class="s1">&#39;argsort&#39;</span><span class="p">,</span>
206208
<span class="s1">&#39;sort&#39;</span>
207209
<span class="p">]</span>
208210

209211

210-
<div class="viewcode-block" id="argsort"><a class="viewcode-back" href="../../numpy_api.html#dpnp.argsort">[docs]</a><span class="k">def</span> <span class="nf">argsort</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
212+
<div class="viewcode-block" id="argsort"><a class="viewcode-back" href="../../dpnp_api.html#dpnp.argsort">[docs]</a><span class="k">def</span> <span class="nf">argsort</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
211213
<span class="sd">&quot;&quot;&quot;</span>
212214
<span class="sd"> Return an ndarray of indices that sort the array along the</span>
213215
<span class="sd"> specified axis. Masked values are filled beforehand to</span>
@@ -278,7 +280,7 @@ <h1>Source code for dpnp.dpnp_iface_sorting</h1><div class="highlight"><pre>
278280
<span class="k">return</span> <span class="n">numpy</span><span class="o">.</span><span class="n">argsort</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="p">,</span> <span class="n">kind</span><span class="p">,</span> <span class="n">order</span><span class="p">)</span></div>
279281

280282

281-
<div class="viewcode-block" id="sort"><a class="viewcode-back" href="../../numpy_api.html#dpnp.sort">[docs]</a><span class="k">def</span> <span class="nf">sort</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
283+
<div class="viewcode-block" id="sort"><a class="viewcode-back" href="../../dpnp_api.html#dpnp.sort">[docs]</a><span class="k">def</span> <span class="nf">sort</span><span class="p">(</span><span class="n">in_array1</span><span class="p">,</span> <span class="n">axis</span><span class="o">=-</span><span class="mi">1</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
282284
<span class="sd">&quot;&quot;&quot;</span>
283285
<span class="sd"> Return a sorted copy of an array.</span>
284286
<span class="sd"> Parameters</span>

0 commit comments

Comments
 (0)