Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update document regarding installation command from github #1202

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
(<https://github.com/openvinotoolkit/datumaro/pull/1195>)
- Fix wrong command to install datumaro from github
(<https://github.com/openvinotoolkit/datumaro/pull/1202>)

## 16/11/2023 - Release 1.5.1
### Enhancements
Expand Down
33 changes: 27 additions & 6 deletions docs/source/docs/get-started/quick-start-guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^
Expand Down
Loading