Skip to content

Commit

Permalink
fix doc version issue (#2744)
Browse files Browse the repository at this point in the history
Co-authored-by: ZhangJianyu <zhang.jianyu@outlook.com>
  • Loading branch information
NeoZhangJianyu and arthw committed Aug 19, 2024
1 parent 4a78881 commit 98966d8
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 17 deletions.
12 changes: 6 additions & 6 deletions v2.15.0.1/docs/install/experimental/install_for_arc_gpu.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h3>Windows Subsystem for Linux 2 (WSL2)<a class="headerlink" href="#windows-sub
<li><p>For Ubuntu Linux 22.04 within WSL2:</p>
<ul>
<li><p>Linux Runtime Libraries: Intel® Arc™ GPU Drivers <a class="reference external" href="https://dgpu-docs.intel.com/releases/LTS_803.29_20240131.html">803</a> (installation instructions below)</p></li>
<li><p>Intel® oneAPI Base Toolkit 2024.1 (installation instructions below)</p></li>
<li><p>Intel® oneAPI Base Toolkit 2024.2.1 (installation instructions below)</p></li>
<li><p>TensorFlow 2.15.1</p></li>
<li><p>Python 3.9-3.11</p></li>
<li><p>pip 19.0 or later (requires manylinux2014 support)</p></li>
Expand All @@ -132,7 +132,7 @@ <h3>Native Linux Running Directly on Hardware<a class="headerlink" href="#native
<li><p>Ubuntu 22.04 (64-bit)</p></li>
<li><p>Intel® GPU Drivers for Linux (installation instructions below)</p></li>
<li><p>Intel® Arc™ GPU Drivers <a class="reference external" href="https://dgpu-docs.intel.com/releases/LTS_803.29_20240131.html">803</a></p></li>
<li><p>Intel® oneAPI Base Toolkit 2024.1 (installation instructions below)</p></li>
<li><p>Intel® oneAPI Base Toolkit 2024.2.1 (installation instructions below)</p></li>
<li><p>TensorFlow 2.15.1</p></li>
<li><p>Python 3.9-3.11</p></li>
<li><p>pip 19.0 or later (requires manylinux2014 support)</p></li>
Expand Down Expand Up @@ -188,7 +188,7 @@ <h5>Ubuntu Linux Installed in WSL2<a class="headerlink" href="#ubuntu-linux-inst
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>gpg-agent<span class="w"> </span>wget
wget<span class="w"> </span>-qO<span class="w"> </span>-<span class="w"> </span>https://repositories.intel.com/gpu/intel-graphics.key<span class="w"> </span><span class="p">|</span><span class="w"> </span>
sudo<span class="w"> </span>gpg<span class="w"> </span>--dearmor<span class="w"> </span>--output<span class="w"> </span>/usr/share/keyrings/intel-graphics.gpg
<span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;deb [arch=.html64 signed-by=/usr/share/keyrings/intel-graphics.gpg] https://repositories.intel.com/gpu/ubuntu jammy/lts/2350 unified&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>/etc/apt/sources.list.d/intel-gpu-jammy.list
<span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;deb [arch=amd64 signed-by=/usr/share/keyrings/intel-graphics.gpg] https://repositories.intel.com/gpu/ubuntu jammy/lts/2350 unified&quot;</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sudo<span class="w"> </span>tee<span class="w"> </span>/etc/apt/sources.list.d/intel-gpu-jammy.list
sudo<span class="w"> </span>apt-get<span class="w"> </span>update
</pre></div>
</div>
Expand Down Expand Up @@ -336,10 +336,10 @@ <h3>Optional: Install Full Intel® oneAPI<a class="headerlink" href="#optional-i
<li><p>Intel® oneAPI Math Kernel Library (oneMKL)</p></li>
</ul>
<p>Download and install the verified DPC++ compiler and oneMKL in Ubuntu 22.04.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>wget<span class="w"> </span>https://registrationcenter-download.intel.com/akdlm/IRC_NAS/fdc7a2bc-b7a8-47eb-8876-de6201297144/l_BaseKit_p_2024.1.0.596.sh
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>wget<span class="w"> </span>https://registrationcenter-download.intel.com/akdlm/IRC_NAS/e6ff8e9c-ee28-47fb-abd7-5c524c983e1c/l_BaseKit_p_2024.2.1.100_offline.sh
<span class="c1"># 3 components are necessary: DPC++/C++ Compiler, DPC++ Library and oneMKL</span>
<span class="c1"># if you want to run distributed training with Intel® Optimization for Horovod*, oneCCL is needed too (Intel® oneAPI MPI Library will be installed automatically as its dependency)</span>
$<span class="w"> </span>sudo<span class="w"> </span>sh<span class="w"> </span>./l_BaseKit_p_2024.1.0.596.sh
$<span class="w"> </span>sudo<span class="w"> </span>sh<span class="w"> </span>l_BaseKit_p_2024.2.1.100_offline.sh
</pre></div>
</div>
<p>For any more details, please follow the procedure in <a class="reference external" href="https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit.html">Intel® oneAPI Base Toolkit</a>.</p>
Expand Down Expand Up @@ -388,4 +388,4 @@ <h4>Setup environment variables<a class="headerlink" href="#setup-environment-va
</script>

</body>
</html>
</html>
11 changes: 5 additions & 6 deletions v2.15.0.1/docs/install/experimental/install_for_gpu_conda.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,21 +116,20 @@ <h2>Preconditions<a class="headerlink" href="#preconditions" title="Link to this
</section>
<section id="step-by-step-instructions">
<h2>Step by step instructions:<a class="headerlink" href="#step-by-step-instructions" title="Link to this heading"></a></h2>
<p>Miniforge is the recommended approach for installing stock TensorFlow. It creates a separate environment to avoid changing any installed software in your system. This is also the easiest way to install the required software especially for the GPU setup.
You can use the following command to install Miniforge. During installation, you may need to press enter and type “yes”. Skip this step, if you have already installed conda.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>curl -L -O &quot;https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh&quot;
<p><strong>Miniforge</strong> is the community (conda-forge) driven minimalistic conda installer. It is the recommended approach for installing stock TensorFlow. It creates a separate environment to avoid changing any installed software in your system. This is also the easiest way to install the required software especially for the GPU setup.</p>
<p>You can use the following command to install Miniforge. During installation, you may need to press enter and type “yes”. Skip this step, if you have already installed conda.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>wget &quot;https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-$(uname)-$(uname -m).sh&quot;
bash Miniforge3-$(uname)-$(uname -m).sh
</pre></div>
</div>
<p>You may need to restart your terminal or <code class="docutils literal notranslate"><span class="pre">source</span> <span class="pre">~/.bashrc</span></code> to enable the conda command. Use this command to test if it is installed successfully.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="o">-</span><span class="n">V</span>
</pre></div>
</div>
<p>You may need to update your conda first, as at least conda 4.1.11 is required.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">conda</span> <span class="n">update</span> <span class="n">conda</span>

<span class="c1">#Take Intel Python 2023.2.0 as an example to conda environment, but generic Python is also recommended.</span>
<span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">itex</span> <span class="o">-</span><span class="n">c</span> <span class="n">intel</span> <span class="n">intelpython3_full</span><span class="o">==</span><span class="mf">2023.2.0</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.9</span>
<span class="n">conda</span> <span class="n">create</span> <span class="o">-</span><span class="n">n</span> <span class="n">itex</span> <span class="o">-</span><span class="n">c</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">software</span><span class="o">.</span><span class="n">repos</span><span class="o">.</span><span class="n">intel</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">python</span><span class="o">/</span><span class="n">conda</span><span class="o">/</span> <span class="n">intelpython3_full</span><span class="o">==</span><span class="mf">2024.2.0</span> <span class="n">python</span><span class="o">=</span><span class="mf">3.9</span>
</pre></div>
</div>
<p>Activate the environment by the following commands.</p>
Expand Down Expand Up @@ -209,4 +208,4 @@ <h2>Step by step instructions:<a class="headerlink" href="#step-by-step-instruct
</script>

</body>
</html>
</html>
8 changes: 4 additions & 4 deletions v2.15.0.1/docs/install/install_for_xpu.html
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ <h2>Software Requirements<a class="headerlink" href="#software-requirements" tit
<li><p>Intel® Data Center GPU Max Series</p></li>
</ul>
</li>
<li><p>Intel® oneAPI Base Toolkit 2024.1</p></li>
<li><p><a class="reference external" href="https://www.intel.com/content/www/us/en/developer/articles/release-notes/intel-oneapi-toolkit-release-notes.html">Intel® oneAPI Base Toolkit 2024.2.1</a></p></li>
<li><p>TensorFlow 2.15.1</p></li>
<li><p>Python 3.9-3.11</p></li>
<li><p>pip 19.0 or later (requires manylinux2014 support)</p></li>
Expand Down Expand Up @@ -219,10 +219,10 @@ <h3>Install oneAPI Base Toolkit Packages<a class="headerlink" href="#install-one
<li><p>Intel® oneAPI Threading Building Blocks (TBB), dependency of DPC++ Compiler.</p></li>
<li><p>Intel® oneAPI Collective Communications Library (oneCCL), required by Intel® Optimization for Horovod* only</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>wget<span class="w"> </span>https://registrationcenter-download.intel.com/akdlm/IRC_NAS/fdc7a2bc-b7a8-47eb-8876-de6201297144/l_BaseKit_p_2024.1.0.596.sh
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>wget<span class="w"> </span>https://registrationcenter-download.intel.com/akdlm/IRC_NAS/e6ff8e9c-ee28-47fb-abd7-5c524c983e1c/l_BaseKit_p_2024.2.1.100_offline.sh
<span class="c1"># 3 components are necessary: DPC++/C++ Compiler, DPC++ Libiary and oneMKL</span>
<span class="c1"># if you want to run distributed training with Intel® Optimization for Horovod*, oneCCL is needed too(Intel® oneAPI MPI Library will be installed automatically as its dependency)</span>
$<span class="w"> </span>sudo<span class="w"> </span>sh<span class="w"> </span>./l_BaseKit_p_2024.1.0.596.sh
$<span class="w"> </span>sudo<span class="w"> </span>sh<span class="w"> </span>l_BaseKit_p_2024.2.1.100_offline.sh
</pre></div>
</div>
<p>For any more details, follow the procedure in https://www.intel.com/content/www/us/en/developer/tools/oneapi/base-toolkit.html.</p>
Expand Down Expand Up @@ -332,4 +332,4 @@ <h2>XPU for CPU only platform (Deprecated)<a class="headerlink" href="#xpu-for-c
</script>

</body>
</html>
</html>
10 changes: 9 additions & 1 deletion v2.15.0.1/get_started.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,15 @@ <h3>Compatibility Table<a class="headerlink" href="#compatibility-table" title="
</thead>
<tbody>
<tr>
<td>Not support</td>
<td>2.17</td>
</tr>
<tr>
<td><a href="docs/install/how_to_build.html">latest build from source</a></td>
<td>2.16</td>
</tr>
<tr>
<td>v2.15.0.0 &amp; v2.15.0.1</td>
<td>2.15</td>
</tr>
<tr>
Expand Down Expand Up @@ -346,4 +354,4 @@ <h2>License<a class="headerlink" href="#license" title="Link to this heading">
</script>

</body>
</html>
</html>

0 comments on commit 98966d8

Please sign in to comment.