diff --git a/docs/source/installation/from_wheels.rst b/docs/source/installation/from_wheels.rst index 2555c0774..f5ddded8f 100644 --- a/docs/source/installation/from_wheels.rst +++ b/docs/source/installation/from_wheels.rst @@ -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 ``_ to see avaiable versions of `k2`_. + macOS (CPU) example -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^ Suppose we want to use the following wheel: @@ -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 ``_ to see avaiable versions of `k2`_. + Windows (CPU) example -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^ Suppose we want to install the following wheel @@ -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 @@ -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 ``_ to see avaiable versions of `k2`_. + Linux (CUDA) example ^^^^^^^^^^^^^^^^^^^^ @@ -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 ``_ to see avaiable versions of `k2`_.