From a3ee1a1c2a6abf95a6bf8880695c79b6de7503df Mon Sep 17 00:00:00 2001 From: Fangjun Kuang Date: Mon, 24 Jul 2023 09:45:30 +0800 Subject: [PATCH] update installation from wheels --- doc/source/installation/from_wheels.rst | 92 +++++++++++++++++++++++++ doc/source/installation/index.rst | 2 +- 2 files changed, 93 insertions(+), 1 deletion(-) diff --git a/doc/source/installation/from_wheels.rst b/doc/source/installation/from_wheels.rst index a019a95..491fcf1 100644 --- a/doc/source/installation/from_wheels.rst +++ b/doc/source/installation/from_wheels.rst @@ -5,3 +5,95 @@ You can find pre-compiled wheels at - CPU wheels: ``_ - CUDA wheels: ``_ + +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 diff --git a/doc/source/installation/index.rst b/doc/source/installation/index.rst index 248d9f3..7d31707 100644 --- a/doc/source/installation/index.rst +++ b/doc/source/installation/index.rst @@ -2,7 +2,7 @@ Installation ============ .. toctree:: - :maxdepth: 2 + :maxdepth: 3 ./from_wheels.rst ./from_source.rst