File size: 1,884 Bytes
d21cb06 | 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 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | ## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Testing](#testing)
- [Design](#design-and-code-structure)
## Installation
### Prerequisites
- Python (3.5+)
``` bash
git clone https://github.com/openvinotoolkit/datumaro
```
Optionally, install a virtual environment (recommended):
``` bash
python -m pip install virtualenv
python -m virtualenv venv
. venv/bin/activate
```
Then install all dependencies:
``` bash
while read -r p; do pip install $p; done < requirements.txt
```
If you're working inside of a CVAT environment:
``` bash
. .env/bin/activate
while read -r p; do pip install $p; done < datumaro/requirements.txt
```
Install Datumaro:
``` bash
pip install -e /path/to/the/cloned/repo/
```
**Optional dependencies**
These components are only required for plugins and not installed by default:
- OpenVINO
- Accuracy Checker
- TensorFlow
- PyTorch
- MxNet
- Caffe
## Usage
``` bash
datum --help
python -m datumaro --help
python datumaro/ --help
python datum.py --help
```
``` python
import datumaro
```
## Testing
It is expected that all Datumaro functionality is covered and checked by
unit tests. Tests are placed in `tests/` directory.
To run tests use:
``` bash
python -m unittest discover -s tests
```
If you're working inside of a CVAT environment, you can also use:
``` bash
python manage.py test datumaro/
```
## Design and code structure
- [Design document](docs/design.md)
- [Developer guide](docs/developer_guide.md)
## Code style
Try to be readable and consistent with the existing codebase.
The project mostly follows PEP8 with little differences.
Continuation lines have a standard indentation step by default,
or any other, if it improves readability. For long conditionals use 2 steps.
No trailing whitespaces, 80 characters per line.
## Environment
The recommended editor is VS Code with the Python plugin. |