Skip to content

Commit

Permalink
update document regarding installation command from github (openvinot…
Browse files Browse the repository at this point in the history
…oolkit#1202)

<!-- Contributing guide:
https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md
-->

### Summary
installation command is updated.
before: `pip install
'git+https://github.com/openvinotoolkit/datumaro[default]'`
after: `pip install 'datumaro[default] @
git+https://github.com/openvinotoolkit/datumaro'`
<!--
Resolves openvinotoolkit#111 and openvinotoolkit#222.
Depends on openvinotoolkit#1000 (for series of dependent commits).

This PR introduces this capability to make the project better in this
and that.

- Added this feature
- Removed that feature
- Fixed the problem openvinotoolkit#1234
-->

### How to test
<!-- Describe the testing procedure for reviewers, if changes are
not fully covered by unit tests or manual testing can be complicated.
-->

### Checklist
<!-- Put an 'x' in all the boxes that apply -->
- [ ] I have added unit tests to cover my changes.​
- [ ] I have added integration tests to cover my changes.​
- [x] I have added the description of my changes into
[CHANGELOG](https://github.com/openvinotoolkit/datumaro/blob/develop/CHANGELOG.md).​
- [x] I have updated the
[documentation](https://github.com/openvinotoolkit/datumaro/tree/develop/docs)
accordingly

### License

- [ ] I submit _my code changes_ under the same [MIT
License](https://github.com/openvinotoolkit/datumaro/blob/develop/LICENSE)
that covers the project.
  Feel free to contact the maintainers if that's a concern.
- [ ] I have updated the license header for each file (see an example
below).

```python
# Copyright (C) 2023 Intel Corporation
#
# SPDX-License-Identifier: MIT
```
  • Loading branch information
Jihyeon Yi authored Nov 27, 2023
1 parent e7f6fea commit 44c1391
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 6 deletions.
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

0 comments on commit 44c1391

Please sign in to comment.