Skip to content

Commit

Permalink
typo fixes for installation doc (#1231)
Browse files Browse the repository at this point in the history
  • Loading branch information
csukuangfj authored Jul 23, 2023
1 parent 44ffa2b commit c5b15d4
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions docs/source/installation/from_wheels.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,20 @@ we can use one of the following methods:
# method 1
pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
pip install k2==1.24.3.dev20230719+cpu.torch2.0.1 -f https://k2-fsa.github.io/k2/cuda.html
pip install k2==1.24.3.dev20230719+cpu.torch2.0.1 -f https://k2-fsa.github.io/k2/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/k2/resolve/main/cpu/k2-1.24.3.dev20230719+cpu.torch2.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
pip install ./k2-1.24.3.dev20230719+cpu.torch2.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.. hint::

You can visit `<https://k2-fsa.github.io/k2/cpu.html>`_ to see avaiable versions of `k2`_.


macOS (CPU) example
^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^

Suppose we want to use the following wheel:

Expand All @@ -54,15 +58,19 @@ we can use the following methods:
# method 1
pip install torch==2.0.1
pip install k2==1.24.3.dev20230720+cpu.torch2.0.1
pip install k2==1.24.3.dev20230720+cpu.torch2.0.1 -f https://k2-fsa.github.io/k2/cpu.html
# method 2
pip install torch==2.0.1
wget https://huggingface.co/csukuangfj/k2/resolve/main/macos/k2-1.24.3.dev20230720+cpu.torch2.0.1-cp38-cp38-macosx_10_9_x86_64.whl
pip install ./k2-1.24.3.dev20230720+cpu.torch2.0.1-cp38-cp38-macosx_10_9_x86_64.whl
.. hint::

You can visit `<https://k2-fsa.github.io/k2/cpu.html>`_ to see avaiable versions of `k2`_.

Windows (CPU) example
^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^

Suppose we want to install the following wheel

Expand All @@ -76,7 +84,7 @@ we can use the one of the following methods:
# method 1
pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
pip install k2==1.24.3.dev20230720+cpu.torch2.0.1
pip install k2==1.24.3.dev20230720+cpu.torch2.0.1 -f https://k2-fsa.github.io/k2/cpu.html
# method 2
pip install torch==2.0.1+cpu -f https://download.pytorch.org/whl/torch_stable.html
Expand All @@ -88,6 +96,10 @@ we can use the one of the following methods:
If you want to build `k2`_ with CUDA support on Windows, please consider compiling
`k2`_ from source.

.. hint::

You can visit `<https://k2-fsa.github.io/k2/cpu.html>`_ to see avaiable versions of `k2`_.

Linux (CUDA) example
^^^^^^^^^^^^^^^^^^^^

Expand All @@ -103,9 +115,13 @@ we can use the following methods:
# method 1
pip install torch==2.0.1+cu117 -f https://download.pytorch.org/whl/torch_stable.html
pip install k2==1.24.3.dev20230718+cuda11.7.torch2.0.1
pip install k2==1.24.3.dev20230718+cuda11.7.torch2.0.1 -f https://k2-fsa.github.io/k2/cuda.html
# method 2
pip install torch==2.0.1+cu117 -f https://download.pytorch.org/whl/torch_stable.html
wget https://huggingface.co/csukuangfj/k2/resolve/main/cuda/k2-1.24.3.dev20230718+cuda11.7.torch2.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
pip install ./k2-1.24.3.dev20230718+cuda11.7.torch2.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
.. hint::

You can visit `<https://k2-fsa.github.io/k2/cuda.html>`_ to see avaiable versions of `k2`_.

0 comments on commit c5b15d4

Please sign in to comment.