File size: 1,311 Bytes
0b32ad6 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
Install S3PRL
=============
Minimal installation
--------------------
This installation only enables the **S3PRL Upstream collection** function to
keep the minimal dependency. To enable all the functions including downstream benchmarking,
you need to follow `Full installation`_.
.. code-block:: bash
pip install s3prl
Editable installation
---------------------
Installing a package in the editable mode means when you use a imported class/function,
the source code of the class/function is right in your cloned repository.
So, when you modify the code inside it, the newly imported class/function will reflect
your modification.
.. code-block:: bash
git clone https://github.com/s3prl/s3prl.git
cd s3prl
pip install -e .
Full installation
------------------
Install all the dependencies to enable all the S3PRL functions. However, there are **LOTS**
of dependencies.
.. code-block:: bash
pip install s3prl[all]
# editable
pip install ".[all]"
Development installation
-------------------------
Install dependencies of full installation and extra packages for development,
including **pytest** for unit-testing and **sphinx** for documentation.
Usually, you will use this installation variant only in editable mode
.. code-block:: bash
pip install ".[dev]"
|