mirror of
https://github.com/k2-fsa/icefall.git
synced 2025-08-08 17:42:21 +00:00
Update doc to clarify the installation order of dependencies. (#279)
This commit is contained in:
parent
f686635b54
commit
981b064007
@ -27,9 +27,21 @@ Installation
|
|||||||
``icefall`` depends on `k2 <https://github.com/k2-fsa/k2>`_ and
|
``icefall`` depends on `k2 <https://github.com/k2-fsa/k2>`_ and
|
||||||
`lhotse <https://github.com/lhotse-speech/lhotse>`_.
|
`lhotse <https://github.com/lhotse-speech/lhotse>`_.
|
||||||
|
|
||||||
We recommend you to install ``k2`` first, as ``k2`` is bound to
|
We recommend you to use the following steps to install the dependencies.
|
||||||
a specific version of PyTorch after compilation. Install ``k2`` also
|
|
||||||
installs its dependency PyTorch, which can be reused by ``lhotse``.
|
- (0) Install PyTorch and torchaudio
|
||||||
|
- (1) Install k2
|
||||||
|
- (2) Install lhotse
|
||||||
|
|
||||||
|
.. caution::
|
||||||
|
|
||||||
|
Installation order matters.
|
||||||
|
|
||||||
|
(0) Install PyTorch and torchaudio
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
|
Please refer `<https://pytorch.org/>`_ to install PyTorch
|
||||||
|
and torchaudio.
|
||||||
|
|
||||||
|
|
||||||
(1) Install k2
|
(1) Install k2
|
||||||
@ -54,14 +66,15 @@ to install ``k2``.
|
|||||||
Please refer to `<https://lhotse.readthedocs.io/en/latest/getting-started.html#installation>`_
|
Please refer to `<https://lhotse.readthedocs.io/en/latest/getting-started.html#installation>`_
|
||||||
to install ``lhotse``.
|
to install ``lhotse``.
|
||||||
|
|
||||||
.. HINT::
|
|
||||||
|
|
||||||
Install ``lhotse`` also installs its dependency `torchaudio <https://github.com/pytorch/audio>`_.
|
.. hint::
|
||||||
|
|
||||||
.. CAUTION::
|
We strongly recommend you to use::
|
||||||
|
|
||||||
|
pip install git+https://github.com/lhotse-speech/lhotse
|
||||||
|
|
||||||
|
to install the latest version of lhotse.
|
||||||
|
|
||||||
If you have installed ``torchaudio``, please consider uninstalling it before
|
|
||||||
installing ``lhotse``. Otherwise, it may update your already installed PyTorch.
|
|
||||||
|
|
||||||
(3) Download icefall
|
(3) Download icefall
|
||||||
--------------------
|
--------------------
|
||||||
|
Loading…
x
Reference in New Issue
Block a user