XAITK JATIC Integrations

Description

"Bucket" to house various examples and resources related to xaitk-saliency integration and scaling for JATIC use as part of the JATIC program.

Installation

The following steps assumes the source tree has been acquired locally.

Install the current version via pip:

pip install .

Alternatively, Poetry can also be used:

poetry install --sync --with dev-linting,dev-testing,dev-docs

Usage

We provide a number of examples based on Jupyter notebooks in the ./examples/ directory to show usage of the xaitk-saliency package with other tools in the ML ecosystem. Similarly, demo notebooks associated with each increment can be found in ./demos/.

Reflections on integrating xaitk-saliency with these tools can be found in ./docs/platform_reflections/.

Documentation

Documentation snapshots for releases as well as the latest master are hosted on ReadTheDocs.

The sphinx-based documentation may also be built locally for the most up-to-date reference:

# Install dependencies
poetry install --sync --with dev-linting,dev-testing,dev-docs
# Navigate to the documentation root.
cd docs
# Build the docs.
poetry run make html
# Open in your favorite browser!
firefox _build/html/index.html

Developer tools

pre-commit hooks
pre-commit hooks are used to ensure that any code meets all linting and formatting guidelines required.
After installing, this will always run before committing to ensure that any commits are following the standards, but you can also manually run the check without committing. If you want to commit despite there being errors, you can add --no-verify to your commit command.
Installing pre-commit hooks:

# Ensure that all dependencies are installed  
poetry install --sync --with dev-linting,dev-testing,dev-docs  
# Initialize pre-commit for the repository  
poetry run pre-commit install  
# Run pre-commit check on all files  
poetry run pre-commit run --all-files  

Contributing

• We follow the general guidelines outlined in the JATIC Software Development Plan.
• The Git Flow branching strategy is used.
• See docs/releasing/release_process.rst for detailed release information.
• See CONTRIBUTING.md for additional contributing information.

License

Apache 2.0

POC: Brian Hu @brian.hu DPOC: Paul Tunison @paul.tunison