You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
75 lines
1.3 KiB
Markdown
75 lines
1.3 KiB
Markdown
## Table of Contents
|
|
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [Testing](#testing)
|
|
- [Design](#design-and-code-structure)
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
- Python (3.5+)
|
|
- OpenVINO (optional)
|
|
|
|
``` bash
|
|
git clone https://github.com/opencv/cvat
|
|
```
|
|
|
|
Optionally, install a virtual environment:
|
|
|
|
``` 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 CVAT environment:
|
|
``` bash
|
|
. .env/bin/activate
|
|
while read -r p; do pip install $p; done < datumaro/requirements.txt
|
|
```
|
|
|
|
## Usage
|
|
|
|
> The directory containing Datumaro should be in the `PYTHONPATH`
|
|
> environment variable or `cvat/datumaro/` should be the current directory.
|
|
|
|
``` 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 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) |