From b75abef4c09d1059e60d579c17dcce0dd79dabc7 Mon Sep 17 00:00:00 2001 From: Fangjun Kuang Date: Sun, 14 Jan 2024 14:28:44 +0800 Subject: [PATCH] update install doc (#90) --- doc/source/installation/from_wheels.rst | 49 +++++++++++++------------ 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/doc/source/installation/from_wheels.rst b/doc/source/installation/from_wheels.rst index 6b00bb1..b57516c 100644 --- a/doc/source/installation/from_wheels.rst +++ b/doc/source/installation/from_wheels.rst @@ -16,20 +16,21 @@ Suppose you want to install the following wheel: .. code-block:: bash - https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cpu/kaldifeat-1.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl + https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cpu/kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-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+cpu -f https://download.pytorch.org/whl/torch_stable.html - pip install kaldifeat==1.25.0.dev20230726+cpu.torch2.0.1 -f https://csukuangfj.github.io/kaldifeat/cpu.html + pip install torch==2.1.2+cpu -f https://download.pytorch.org/whl/torch_stable.html + pip install kaldifeat==1.25.3.dev20231221+cpu.torch2.1.2 -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/ubuntu-cpu/kaldifeat-1.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl - pip install ./kaldifeat-1.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl + pip install torch==2.1.2+cpu -f https://download.pytorch.org/whl/torch_stable.html + wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cpu/kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl + pip install ./kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl Windows (CPU) @@ -39,20 +40,20 @@ Suppose you want to install the following wheel: .. code-block:: bash - https://huggingface.co/csukuangfj/kaldifeat/resolve/main/windows-cpu/kaldifeat-1.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-win_amd64.whl + https://huggingface.co/csukuangfj/kaldifeat/resolve/main/windows-cpu/kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-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.25.0.dev20230726+cpu.torch2.0.1 -f https://csukuangfj.github.io/kaldifeat/cpu.html + pip install torch==2.1.2+cpu -f https://download.pytorch.org/whl/torch_stable.html + pip install kaldifeat==1.25.3.dev20231221+cpu.torch2.1.2 -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.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-win_amd64.whl - pip install ./kaldifeat-1.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-win_amd64.whl + pip install torch==2.1.2+cpu -f https://download.pytorch.org/whl/torch_stable.html + wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/windows-cpu/kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-cp311-cp311-win_amd64.whl + pip install ./kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-cp311-cp311-win_amd64.whl macOS (CPU) ----------- @@ -61,20 +62,20 @@ Suppose you want to install the following wheel: .. code-block:: bash - https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl + https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-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.25.0.dev20230726+cpu.torch2.0.1 -f https://csukuangfj.github.io/kaldifeat/cpu.html + pip install torch==2.1.2 + pip install kaldifeat==1.25.3.dev20231221+cpu.torch2.1.2 -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.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl - pip install ./kaldifeat-1.25.0.dev20230726+cpu.torch2.0.1-cp311-cp311-macosx_10_9_x86_64.whl + pip install torch==2.1.2 -f https://download.pytorch.org/whl/torch_stable.html + wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/macos/kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-cp311-cp311-macosx_10_9_x86_64.whl + pip install ./kaldifeat-1.25.3.dev20231221+cpu.torch2.1.2-cp311-cp311-macosx_10_9_x86_64.whl Linux (CUDA) ------------ @@ -83,17 +84,17 @@ Suppose you want to install the following wheel: .. code-block:: bash - https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cuda/kaldifeat-1.25.0.dev20230726+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl + https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cuda/kaldifeat-1.25.3.dev20231221+cuda12.1.torch2.1.2-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.25.0.dev20230726+cuda11.8.torch2.0.1 -f https://csukuangfj.github.io/kaldifeat/cuda.html + pip install torch==2.1.2+cu121 -f https://download.pytorch.org/whl/torch_stable.html + pip install kaldifeat==1.25.3.dev20231221+cuda12.1.torch2.1.2 -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.25.0.dev20230724+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl - pip install ./kaldifeat-1.25.0.dev20230726+cuda11.8.torch2.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl + pip install torch==2.1.2+cu121 -f https://download.pytorch.org/whl/torch_stable.html + wget https://huggingface.co/csukuangfj/kaldifeat/resolve/main/ubuntu-cuda/kaldifeat-1.25.3.dev20231221+cuda12.1.torch2.1.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl + pip install ./kaldifeat-1.25.3.dev20231221+cuda12.1.torch2.1.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl