Metadata-Version: 2.1
Name: xaitk-jatic
Version: 0.4.3
Summary: Integration package to support interfacing, implementation and example needs for the JATIC.
License: Apache-2.0
Author: Kitware, Inc.
Author-email: xaitk@kitware.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: docker
Provides-Extra: tools
Requires-Dist: kwcoco (>=0.2.18) ; extra == "tools"
Requires-Dist: maite (>=0.6.0,<0.7.0)
Requires-Dist: matplotlib (>=3.4.1) ; extra == "tools" or extra == "docker"
Requires-Dist: numpy (>=1.22,<2.0) ; python_version < "3.12"
Requires-Dist: numpy (>=1.26,<2.0) ; python_version >= "3.12" and python_version < "3.13"
Requires-Dist: scipy (>=1.10.0)
Requires-Dist: setuptools (>=65.6.3)
Requires-Dist: timm (>=1.0.7,<2.0.0) ; extra == "docker"
Requires-Dist: torchvision (>=0.10.0) ; extra == "docker"
Requires-Dist: transformers (>=4.42.3,<5.0.0) ; extra == "docker"
Requires-Dist: xaitk-saliency (>=0.9.2)
Project-URL: Documentation, https://xaitk-jatic.readthedocs.io/
Description-Content-Type: text/markdown

<!-- :auto badges: -->
[![PyPI - Python Version](https://img.shields.io/pypi/v/xaitk-jatic)](https://pypi.org/project/xaitk-jatic/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xaitk-jatic)
[![Documentation Status](https://readthedocs.org/projects/xaitk-jatic/badge/?version=latest)](https://xaitk-jatic.readthedocs.io/en/latest/?badge=latest)
<!-- :auto badges: -->

# XAITK JATIC Integrations

"Bucket" to house various examples and resources related to
[`xaitk-saliency`](https://github.com/xaitk/xaitk-saliency)
integration and scaling for JATIC use as part of the JATIC program.

<!-- :auto installation: -->
## Installation
Ensure the source tree is acquired locally before proceeding.

To install the current version via `pip`:
```bash
pip install xaitk-jatic
```

Alternatively, you can use [Poetry](https://python-poetry.org/):
```bash
poetry install
```

Certain plugins may require additional runtime dependencies. Details on these requirements can be found [here](https://xaitk-jatic.readthedocs.io/en/latest/implementations.html).

For more detailed installation instructions, visit the [installation documentation](https://xaitk-jatic.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->

<!-- :auto getting-started: -->
## Getting Started
Explore usage examples of the `xaitk-jatic` package in various contexts using the Jupyter notebooks provided in the `./examples/` directory.

Contributions are encouraged! For more details, refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
<!-- :auto getting-started: -->

<!-- :auto documentation: -->
## Documentation
Documentation for both release snapshots and the latest master branch is available on [ReadTheDocs](https://xaitk-jatic.readthedocs.io/en/latest/).

To build the Sphinx-based documentation locally for the latest reference:
```bash
# Install dependencies
poetry install --sync --with 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.html
```
<!-- :auto documentation: -->

<!-- :auto developer-tools: -->
## Developer Tools

### Pre-commit Hooks
Pre-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:
```bash
# Install required dependencies
poetry install --sync --with 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
```
<!-- :auto developer-tools: -->

<!-- :auto contributing: -->
## Contributing
- Follow the [JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).
- Adopt the Git Flow branching strategy.
- Detailed release information is available in [docs/release_process.rst](./docs/release_process.rst).
- Additional contribution guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).
<!-- :auto contributing: -->

<!-- :auto license: -->
## License
[Apache 2.0](./LICENSE)
<!-- :auto license: -->

<!-- :auto contacts: -->
## Contacts

**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
<!-- :auto contacts: -->
