deploy: 1868136b403502463797bffd3f58e11dd08685da

_sources/installation/from_wheels.rst.txt

@@ -5,3 +5,95 @@ You can find pre-compiled wheels at
 
   - CPU wheels: `<https://csukuangfj.github.io/kaldifeat/cpu.html>`_
   - CUDA wheels: `<https://csukuangfj.github.io/kaldifeat/cuda.html>`_
+
+We give a few examples below to show you how to install `kaldifeat`_ from
+pre-compiled wheels.
+
+Linux (CPU)
+-----------
+
+Suppose you want to install the following wheel:
+
+.. code-block:: bash
+
+   https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+
+you can use one of the following methods:
+
+.. code-block:: bash
+
+   # method 1
+   pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
+   pip install kaldifeat==1.24.dev20230722+cpu.torch2.0.1 -f https://csukuangfj.github.io/kaldifeat/cpu.html
+
+   # method 2
+   pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
+   wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+   pip install ./kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+
+
+Windows (CPU)
+--------------
+
+Suppose you want to install the following wheel:
+
+.. code-block:: bash
+
+   https://huggingface.co/csukuangfj/kaldifeat/resolve/main/windows-cpu/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-win_amd64.whl
+
+you can use one of the following methods:
+
+.. code-block:: bash
+
+   # method 1
+   pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
+   pip install kaldifeat==1.24.dev20230722+cpu.torch2.0.1 -f https://csukuangfj.github.io/kaldifeat/cpu.html
+
+   # method 2
+   pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
+   wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/windows-cpu/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-win_amd64.whl
+   pip install ./kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-win_amd64.whl
+
+macOS (CPU)
+-----------
+
+Suppose you want to install the following wheel:
+
+.. code-block:: bash
+
+   https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+
+you can use one of the following methods:
+
+.. code-block:: bash
+
+   # method 1
+   pip install torch==2.0.1
+   pip install kaldifeat==1.24.dev20230722+cpu.torch2.0.1 -f https://csukuangfj.github.io/kaldifeat/cpu.html
+
+   # method 2
+   pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
+   wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+   pip install ./kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+
+Linux (CUDA)
+------------
+
+Suppose you want to install the following wheel:
+
+.. code-block:: bash
+
+   https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cuda/kaldifeat-1.24.dev20230722+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+
+you can use one of the following methods:
+
+.. code-block:: bash
+
+   # method 1
+   pip install torch==2.0.1+cu118 -f https://download.pytorch.org/whl/torch_stable.html
+   pip install kaldifeat==1.24.dev20230722+cuda11.8.torch2.0.1  -f https://csukuangfj.github.io/kaldifeat/cuda.html
+
+   # method 2
+   pip install torch==2.0.1+cu118 -f https://download.pytorch.org/whl/torch_stable.html
+   wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cuda/kaldifeat-1.24.dev20230722+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+   pip install ./kaldifeat-1.24.dev20230722+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

_sources/installation/index.rst.txt

@@ -2,7 +2,7 @@ Installation
 ============
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    ./from_wheels.rst
    ./from_source.rst

installation/from_wheels.html

@@ -49,7 +49,13 @@
 <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Installation</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="#">From pre-compiled wheels (Recommended)</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">From pre-compiled wheels (Recommended)</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="#linux-cpu">Linux (CPU)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#windows-cpu">Windows (CPU)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#macos-cpu">macOS (CPU)</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#linux-cuda">Linux (CUDA)</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="from_source.html">Install kaldifeat from source</a></li>
 <li class="toctree-l2"><a class="reference internal" href="faq.html">FAQs</a></li>
 </ul>
@@ -91,6 +97,80 @@
 <li><p>CUDA wheels: <a class="reference external" href="https://csukuangfj.github.io/kaldifeat/cuda.html">https://csukuangfj.github.io/kaldifeat/cuda.html</a></p></li>
 </ul>
 </div></blockquote>
+<p>We give a few examples below to show you how to install <a class="reference external" href="https://github.com/csukuangfj/kaldifeat">kaldifeat</a> from
+pre-compiled wheels.</p>
+<section id="linux-cpu">
+<h2>Linux (CPU)<a class="headerlink" href="#linux-cpu" title="Permalink to this heading"></a></h2>
+<p>Suppose you want to install the following wheel:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+</pre></div>
+</div>
+<p>you can use one of the following methods:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># method 1</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1+cpu<span class="w"> </span>-f<span class="w"> </span>https://download.pytorch.org/whl/torch_stable.html
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">kaldifeat</span><span class="o">==</span><span class="m">1</span>.24.dev20230722+cpu.torch2.0.1<span class="w"> </span>-f<span class="w"> </span>https://csukuangfj.github.io/kaldifeat/cpu.html
+
+<span class="c1"># method 2</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1+cpu<span class="w"> </span>-f<span class="w"> </span>https://download.pytorch.org/whl/torch_stable.html
+wget<span class="w"> </span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+pip<span class="w"> </span>install<span class="w"> </span>./kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+</pre></div>
+</div>
+</section>
+<section id="windows-cpu">
+<h2>Windows (CPU)<a class="headerlink" href="#windows-cpu" title="Permalink to this heading"></a></h2>
+<p>Suppose you want to install the following wheel:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/windows-cpu/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-win_amd64.whl
+</pre></div>
+</div>
+<p>you can use one of the following methods:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># method 1</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1+cpu<span class="w"> </span>-f<span class="w"> </span>https://download.pytorch.org/whl/torch_stable.html
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">kaldifeat</span><span class="o">==</span><span class="m">1</span>.24.dev20230722+cpu.torch2.0.1<span class="w"> </span>-f<span class="w"> </span>https://csukuangfj.github.io/kaldifeat/cpu.html
+
+<span class="c1"># method 2</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1+cpu<span class="w"> </span>-f<span class="w"> </span>https://download.pytorch.org/whl/torch_stable.html
+wget<span class="w"> </span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/windows-cpu/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-win_amd64.whl
+pip<span class="w"> </span>install<span class="w"> </span>./kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-win_amd64.whl
+</pre></div>
+</div>
+</section>
+<section id="macos-cpu">
+<h2>macOS (CPU)<a class="headerlink" href="#macos-cpu" title="Permalink to this heading"></a></h2>
+<p>Suppose you want to install the following wheel:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+</pre></div>
+</div>
+<p>you can use one of the following methods:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># method 1</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">kaldifeat</span><span class="o">==</span><span class="m">1</span>.24.dev20230722+cpu.torch2.0.1<span class="w"> </span>-f<span class="w"> </span>https://csukuangfj.github.io/kaldifeat/cpu.html
+
+<span class="c1"># method 2</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1+cpu<span class="w"> </span>-f<span class="w"> </span>https://download.pytorch.org/whl/torch_stable.html
+wget<span class="w"> </span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+pip<span class="w"> </span>install<span class="w"> </span>./kaldifeat-1.24.dev20230722+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl
+</pre></div>
+</div>
+</section>
+<section id="linux-cuda">
+<h2>Linux (CUDA)<a class="headerlink" href="#linux-cuda" title="Permalink to this heading"></a></h2>
+<p>Suppose you want to install the following wheel:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cuda/kaldifeat-1.24.dev20230722+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+</pre></div>
+</div>
+<p>you can use one of the following methods:</p>
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># method 1</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1+cu118<span class="w"> </span>-f<span class="w"> </span>https://download.pytorch.org/whl/torch_stable.html
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">kaldifeat</span><span class="o">==</span><span class="m">1</span>.24.dev20230722+cuda11.8.torch2.0.1<span class="w">  </span>-f<span class="w"> </span>https://csukuangfj.github.io/kaldifeat/cuda.html
+
+<span class="c1"># method 2</span>
+pip<span class="w"> </span>install<span class="w"> </span><span class="nv">torch</span><span class="o">==</span><span class="m">2</span>.0.1+cu118<span class="w"> </span>-f<span class="w"> </span>https://download.pytorch.org/whl/torch_stable.html
+wget<span class="w"> </span>https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cuda/kaldifeat-1.24.dev20230722+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+pip<span class="w"> </span>install<span class="w"> </span>./kaldifeat-1.24.dev20230722+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
+</pre></div>
+</div>
+</section>
 </section>
 
 

installation/index.html

@@ -85,7 +85,13 @@
 <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this heading"></a></h1>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="from_wheels.html">From pre-compiled wheels (Recommended)</a></li>
+<li class="toctree-l1"><a class="reference internal" href="from_wheels.html">From pre-compiled wheels (Recommended)</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="from_wheels.html#linux-cpu">Linux (CPU)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="from_wheels.html#windows-cpu">Windows (CPU)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="from_wheels.html#macos-cpu">macOS (CPU)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="from_wheels.html#linux-cuda">Linux (CUDA)</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="from_source.html">Install kaldifeat from source</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="from_source.html#install-kaldifeat-from-pypi">Install kaldifeat from PyPI</a></li>
 </ul>