Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

typo fixes for installation doc #1231

Merged
merged 1 commit into from
Jul 23, 2023
Merged

typo fixes for installation doc #1231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions docs/source/installation/from_wheels.rst
View file
Open in desktop
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`_.