Docs for pull request 2058

Author: github-actions[doc-deploy-bot]

pulls/2058/_modules/dpctl/tensor/_copy_utils.html

@@ -905,9 +905,7 @@ <h1>Source code for dpctl.tensor._copy_utils</h1><div class="highlight"><pre>
     <span class="p">)</span>
 
 
-<div class="viewcode-block" id="from_numpy"><a class="viewcode-back" href="../../../api_reference/dpctl/generated/dpctl.tensor.from_numpy.html#dpctl.tensor.from_numpy">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">from_numpy</span><span class="p">(</span>
-    <span class="n">np_ary</span><span class="p">,</span> <span class="o">/</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">usm_type</span><span class="o">=</span><span class="s2">&quot;device&quot;</span><span class="p">,</span> <span class="n">sycl_queue</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="s2">&quot;K&quot;</span>
-<span class="p">):</span>
+<div class="viewcode-block" id="from_numpy"><a class="viewcode-back" href="../../../api_reference/dpctl/generated/dpctl.tensor.from_numpy.html#dpctl.tensor.from_numpy">[docs]</a><span class="k">def</span><span class="w"> </span><span class="nf">from_numpy</span><span class="p">(</span><span class="n">np_ary</span><span class="p">,</span> <span class="o">/</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">usm_type</span><span class="o">=</span><span class="s2">&quot;device&quot;</span><span class="p">,</span> <span class="n">sycl_queue</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    from_numpy(arg, device=None, usm_type=&quot;device&quot;, sycl_queue=None)</span>
 
@@ -1141,6 +1139,10 @@ <h1>Source code for dpctl.tensor._copy_utils</h1><div class="highlight"><pre>
 
 
 <span class="k">def</span><span class="w"> </span><span class="nf">_make_empty_like_orderK</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">usm_type</span><span class="p">,</span> <span class="n">dev</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Returns empty array with shape and strides like `X`, with dtype `dt`,</span>
+<span class="sd">    USM type `usm_type`, on device `dev`.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">st</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">strides</span><span class="p">)</span>
     <span class="n">perm</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span>
         <span class="nb">range</span><span class="p">(</span><span class="n">X</span><span class="o">.</span><span class="n">ndim</span><span class="p">),</span>
@@ -1166,7 +1168,8 @@ <h1>Source code for dpctl.tensor._copy_utils</h1><div class="highlight"><pre>
 
 
 <span class="k">def</span><span class="w"> </span><span class="nf">_empty_like_orderK</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">usm_type</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dev</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns empty array like `x`, using order=&#39;K&#39;</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Returns empty array like `x`, using order=&#39;K&#39;</span>
 
 <span class="sd">    For an array `x` that was obtained by permutation of a contiguous</span>
 <span class="sd">    array the returned array will have the same shape and the same</span>
@@ -1191,7 +1194,8 @@ <h1>Source code for dpctl.tensor._copy_utils</h1><div class="highlight"><pre>
 
 
 <span class="k">def</span><span class="w"> </span><span class="nf">_from_numpy_empty_like_orderK</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">usm_type</span><span class="p">,</span> <span class="n">dev</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;Returns empty usm_ndarray like NumPy array `x`, using order=&#39;K&#39;</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Returns empty usm_ndarray like NumPy array `x`, using order=&#39;K&#39;</span>
 
 <span class="sd">    For an array `x` that was obtained by permutation of a contiguous</span>
 <span class="sd">    array the returned array will have the same shape and the same</span>
@@ -1201,11 +1205,11 @@ <h1>Source code for dpctl.tensor._copy_utils</h1><div class="highlight"><pre>
         <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Expected np.ndarray, got </span><span class="si">{</span><span class="nb">type</span><span class="p">(</span><span class="n">X</span><span class="p">)</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
     <span class="n">fl</span> <span class="o">=</span> <span class="n">X</span><span class="o">.</span><span class="n">flags</span>
     <span class="k">if</span> <span class="n">fl</span><span class="p">[</span><span class="s2">&quot;C&quot;</span><span class="p">]</span> <span class="ow">or</span> <span class="n">X</span><span class="o">.</span><span class="n">size</span> <span class="o">&lt;=</span> <span class="mi">1</span><span class="p">:</span>
-        <span class="k">return</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">(</span>
+        <span class="k">return</span> <span class="n">dpt</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span>
             <span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dt</span><span class="p">,</span> <span class="n">usm_type</span><span class="o">=</span><span class="n">usm_type</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s2">&quot;C&quot;</span>
         <span class="p">)</span>
     <span class="k">elif</span> <span class="n">fl</span><span class="p">[</span><span class="s2">&quot;F&quot;</span><span class="p">]:</span>
-        <span class="k">return</span> <span class="n">dpt</span><span class="o">.</span><span class="n">usm_ndarray</span><span class="p">(</span>
+        <span class="k">return</span> <span class="n">dpt</span><span class="o">.</span><span class="n">empty</span><span class="p">(</span>
             <span class="n">X</span><span class="o">.</span><span class="n">shape</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">dt</span><span class="p">,</span> <span class="n">usm_type</span><span class="o">=</span><span class="n">usm_type</span><span class="p">,</span> <span class="n">device</span><span class="o">=</span><span class="n">dev</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="s2">&quot;F&quot;</span>
         <span class="p">)</span>
     <span class="k">return</span> <span class="n">_make_empty_like_orderK</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="n">dt</span><span class="p">,</span> <span class="n">usm_type</span><span class="p">,</span> <span class="n">dev</span><span class="p">)</span>

pulls/2058/api_reference/dpctl/generated/dpctl.program.create_program_from_spirv.html

@@ -799,9 +799,9 @@ <h1>dpctl.program.create_program_from_spirv<a class="headerlink" href="#dpctl-pr
 <dt class="sig sig-object py" id="dpctl.program.create_program_from_spirv">
 <span class="sig-prename descclassname"><span class="pre">dpctl.program.</span></span><span class="sig-name descname"><span class="pre">create_program_from_spirv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">q</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">IL</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">copts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dpctl.program.create_program_from_spirv" title="Permalink to this definition">¶</a></dt>
 <dd><p>Creates a Sycl interoperability program from an SPIR-V binary.</p>
-<p>We use the <code class="xref c c-func docutils literal notranslate"><span class="pre">DPCTLKernelBundle_CreateFromOCLSpirv()</span></code> C API function to
-create a <code class="docutils literal notranslate"><span class="pre">sycl::kernel_bundle&lt;sycl::bundle_state::executable&gt;</span></code> object
-from an compiled SPIR-V binary file.</p>
+<p>We use the <code class="xref c c-func docutils literal notranslate"><span class="pre">DPCTLKernelBundle_CreateFromOCLSpirv()</span></code> C API function
+to create a <code class="docutils literal notranslate"><span class="pre">sycl::kernel_bundle&lt;sycl::bundle_state::executable&gt;</span></code>
+object from an compiled SPIR-V binary file.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">