The nrtk package is an open source toolkit for evaluating the natural robustness of computer vision
algorithms to various perturbations, including sensor-specific changes to camera focal length, aperture
diameter, etc. Functionality is provided through Strategy
and Adapter patterns to allow for modular integration
into systems and applications.
We have also created the nrtk-jatic package to support AI T&E
use-cases and workflows, through interoperability with the maite
library and integration with other JATIC tools. Users seeking to use NRTK to
perturb MAITE-wrapped datasets or evaluate MAITE-wrapped models should
start with the nrtk-jatic package.
Ensure the source tree is acquired locally before proceeding.
To install the current version via pip:
pip install nrtk[<extra1>,<extra2>,...]Alternatively, you can use Poetry:
poetry install --with main,linting,tests,docs --extras "<extra1> <extra2> ..."Certain plugins may require additional runtime dependencies. Details on these requirements can be found here.
For more detailed installation instructions, visit the installation documentation.
Explore usage examples of the nrtk package in various contexts using the Jupyter notebooks provided in the ./examples/ directory.
Contributions are encouraged! For more details, refer to the CONTRIBUTING.md file.
Documentation for both release snapshots and the latest master branch is available on ReadTheDocs.
To build the Sphinx-based documentation locally for the latest reference:
# Install dependencies
poetry install --sync --with main,linting,tests,docs
# Navigate to the documentation root
cd docs
# Build the documentation
poetry run make html
# Open the generated documentation in your browser
firefox _build/html/index.htmlPre-commit hooks ensure that code complies with required linting and formatting guidelines. These hooks run automatically before commits but can also be executed manually. To bypass checks during a commit, use the --no-verify flag.
To install and use pre-commit hooks:
# Install required dependencies
poetry install --sync --with main,linting,tests,docs
# Initialize pre-commit hooks for the repository
poetry run pre-commit install
# Run pre-commit checks on all files
poetry run pre-commit run --all-files- Follow the JATIC Design Principles.
- Adopt the Git Flow branching strategy.
- Detailed release information is available in docs/release_process.rst.
- Additional contribution guidelines can be found in CONTRIBUTING.md.
Principal Investigator: Brian Hu (Kitware) @brian.hu
Product Owner: Austin Whitesell (MITRE) @awhitesell
Scrum Master / Tech Lead: Brandon RichardWebster (Kitware) @b.richardwebster
Deputy Tech Lead: Emily Veenhuis (Kitware) @emily.veenhuis