diff --git a/CHANGELOG.md b/CHANGELOG.md index ae43e4eadf..82388fadce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Bug fixes - Fix wrong example of Datumaro dataset creation in document () +- Fix wrong command to install datumaro from github + () ## 16/11/2023 - Release 1.5.1 ### Enhancements diff --git a/docs/source/docs/get-started/quick-start-guide/installation.rst b/docs/source/docs/get-started/quick-start-guide/installation.rst index 31054ccc8a..9b8625c232 100644 --- a/docs/source/docs/get-started/quick-start-guide/installation.rst +++ b/docs/source/docs/get-started/quick-start-guide/installation.rst @@ -20,15 +20,36 @@ Optionally, set up a virtual environment: Install: -.. code-block:: +1. From PyPI (**recommended**) - # From PyPI: - pip install datumaro[default] + .. code-block:: -.. code-block:: + pip install datumaro[default] + + Alternatively, for zsh users: + + .. code-block:: + + pip install 'datumaro[default]' + + +2. From the GitHub repository (**not recommended, for advanced users**) + + Installation from the repository source is not recommended. + This is because it requires that C++ and Rust build systems are prepared in your local environment before installation. + Datumaro includes C++ and Rust implementations to accelerate some workloads to overcome Python's innate slowness. + + .. code-block:: + + # Prerequisite (For Unix-like systems) + # Install C++ build system + sudo apt-get install build-essential + # Install Rust build system + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + + # Install from the GitHub repository + pip install 'datumaro[default] @ git+https://github.com/openvinotoolkit/datumaro' - # From the GitHub repository: - pip install 'git+https://github.com/openvinotoolkit/datumaro[default]' Plugins ^^^^^^^