Skip to content

Latest commit

 

History

History
70 lines (55 loc) · 2.51 KB

README.md

File metadata and controls

70 lines (55 loc) · 2.51 KB

annotation_utils

Utilities that are used for assisting with making annotated data.

Installation

Install From Github

# For installing from the master branch (stable)
pip install https://github.com/cm107/annotation_utils/archive/master.zip

# For installing from the development (latest)
pip install https://github.com/cm107/annotation_utils/archive/development.zip

Note: If you want to reinstall all dependencies while installing, use the following commands instead:

# For installing from the master branch (stable)
pip install --upgrade --force-reinstall https://github.com/cm107/annotation_utils/archive/master.zip

# For installing from the development (latest)
pip install --upgrade --force-reinstall https://github.com/cm107/annotation_utils/archive/development.zip

Install From Pypi

pip install pyclay-annotation_utils

Note: The github package is updated more often than the pypi package.

Note: In order to overwrite an older version with the latest version, use the following command instead.

# Warning: This will automatically upgrade the dependencies too.
pip install --upgrade pyclay-annotation_utils

Install From Source

This package can also be installed locally.

git clone https://github.com/cm107/annotation_utils.git
cd annotation_utils
pip install -e .

Update Build

If you change the code and want to re-build the package, do the following.

./build_package.sh

Important Note

Usage

There is not any official documentation about usage yet, but for usage examples you may refer to the test folder.

Documents

The following documents have been written for further explanation.