| Name | xaitk-saliency JSON |
| Version |
0.11.0
JSON |
| download |
| home_page | None |
| Summary | Visual saliency map generation interfaces and baseline implementations for explainable AI. |
| upload_time | 2025-01-12 00:28:58 |
| maintainer | None |
| docs_url | None |
| author | Kitware, Inc. |
| requires_python | <4.0,>=3.9 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<hr/>
<!-- :auto badges: -->
[](https://pypi.org/project/xaitk-saliency/)
[](https://xaitk-saliency.readthedocs.io/en/latest/?badge=latest)
<!-- :auto badges: -->
<!-- TODO: re-enable these later. -->
<!-- [](https://github.com/XAITK/xaitk-saliency/actions/workflows/ci-unittests.yml)
[](https://github.com/XAITK/xaitk-saliency/actions/workflows/ci-example-notebooks.yml) -->
[](https://codecov.io/gh/XAITK/xaitk-saliency)
# XAITK - Saliency
The `xaitk-saliency` package is an open source, Explainable AI (XAI) framework
for visual saliency algorithm interfaces and implementations, built for
analytics and autonomy applications.
See [here](https://xaitk-saliency.readthedocs.io/en/latest/introduction.html)
for a more formal introduction to the topic of XAI and visual saliency
explanations.
This framework is a part of the [Explainable AI Toolkit (XAITK)](
https://xaitk.org).
## Supported Algorithms
The `xaitk-saliency` package provides saliency algorithms for a wide range of image understanding
tasks, including image classification, image similarity, object detection, and reinforcement learning.
The current list of supported saliency algorithms can be found [here](
https://xaitk-saliency.readthedocs.io/en/latest/introduction.html#saliency-algorithms).
## Target Audience
This toolkit is intended to help data scientists and developers who want to
add visual saliency explanations to their workflow or product.
Functionality provided here is both directly accessible for targeted
experimentation, and through [Strategy](
https://en.wikipedia.org/wiki/Strategy_pattern) and [Adapter](
https://en.wikipedia.org/wiki/Adapter_pattern) patterns to allow for
modular integration into systems and applications.
<!-- :auto installation: -->
## Installation
Ensure the source tree is acquired locally before proceeding.
To install the current version via `pip`:
```bash
pip install xaitk-saliency[<extra1>,<extra2>,...]
```
Alternatively, you can use [Poetry](https://python-poetry.org/):
```bash
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](https://xaitk-saliency.readthedocs.io/en/latest/implementations.html).
For more detailed installation instructions, visit the [installation documentation](https://xaitk-saliency.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->
<!-- :auto getting-started: -->
## Getting Started
Explore usage examples of the `xaitk-saliency` 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-saliency.readthedocs.io/en/latest/).
To build the Sphinx-based documentation locally for the latest reference:
```bash
# 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.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 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
```
<!-- :auto developer-tools: -->
## XAITK Saliency Demonstration Tool
This [associated project](https://github.com/XAITK/xaitk-saliency-web-demo)
provides a local web-application that provides a demonstration of visual
saliency generation in a user-interface.
This provides an example of how visual saliency, as generated by this package,
can be utilized in a user-interface to facilitate model and results
exploration.
This tool uses the [trame framework](https://kitware.github.io/trame/).
| ![image1] | ![image2] | ![image3] | ![image4] |
|:---------:|:---------:|:---------:|:---------:|
[image1]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-classification-rise-4.jpg
[image2]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-classification-sliding-window.jpg
[image3]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-detection-retina.jpg
[image4]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-similarity-1.jpg
<!-- :auto license: -->
## License
[Apache 2.0](./LICENSE)
<!-- :auto license: -->
All development prior to Nov 19, 2024 falls under [BSD-3-Clause](./LICENSE.old)
<!-- :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: -->
Raw data
{
"_id": null,
"home_page": null,
"name": "xaitk-saliency",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Kitware, Inc.",
"author_email": "xaitk@kitware.com",
"download_url": "https://files.pythonhosted.org/packages/fc/ed/57ed1fea2259ec2df95c7392752dfc656e2db0449892a69540bced3635a5/xaitk_saliency-0.11.0.tar.gz",
"platform": null,
"description": "\n\n<hr/>\n\n<!-- :auto badges: -->\n[](https://pypi.org/project/xaitk-saliency/)\n\n[](https://xaitk-saliency.readthedocs.io/en/latest/?badge=latest)\n<!-- :auto badges: -->\n<!-- TODO: re-enable these later. -->\n<!-- [](https://github.com/XAITK/xaitk-saliency/actions/workflows/ci-unittests.yml)\n[](https://github.com/XAITK/xaitk-saliency/actions/workflows/ci-example-notebooks.yml) -->\n[](https://codecov.io/gh/XAITK/xaitk-saliency)\n\n# XAITK - Saliency\nThe `xaitk-saliency` package is an open source, Explainable AI (XAI) framework\nfor visual saliency algorithm interfaces and implementations, built for\nanalytics and autonomy applications.\n\nSee [here](https://xaitk-saliency.readthedocs.io/en/latest/introduction.html)\nfor a more formal introduction to the topic of XAI and visual saliency\nexplanations.\n\nThis framework is a part of the [Explainable AI Toolkit (XAITK)](\nhttps://xaitk.org).\n\n## Supported Algorithms\nThe `xaitk-saliency` package provides saliency algorithms for a wide range of image understanding\ntasks, including image classification, image similarity, object detection, and reinforcement learning.\nThe current list of supported saliency algorithms can be found [here](\nhttps://xaitk-saliency.readthedocs.io/en/latest/introduction.html#saliency-algorithms).\n\n## Target Audience\nThis toolkit is intended to help data scientists and developers who want to\nadd visual saliency explanations to their workflow or product.\nFunctionality provided here is both directly accessible for targeted\nexperimentation, and through [Strategy](\nhttps://en.wikipedia.org/wiki/Strategy_pattern) and [Adapter](\nhttps://en.wikipedia.org/wiki/Adapter_pattern) patterns to allow for\nmodular integration into systems and applications.\n\n<!-- :auto installation: -->\n## Installation\nEnsure the source tree is acquired locally before proceeding.\n\nTo install the current version via `pip`:\n```bash\npip install xaitk-saliency[<extra1>,<extra2>,...]\n```\n\nAlternatively, you can use [Poetry](https://python-poetry.org/):\n```bash\npoetry install --with main,linting,tests,docs --extras \"<extra1> <extra2> ...\"\n```\n\nCertain plugins may require additional runtime dependencies. Details on these requirements can be found [here](https://xaitk-saliency.readthedocs.io/en/latest/implementations.html).\n\nFor more detailed installation instructions, visit the [installation documentation](https://xaitk-saliency.readthedocs.io/en/latest/installation.html).\n<!-- :auto installation: -->\n\n<!-- :auto getting-started: -->\n## Getting Started\nExplore usage examples of the `xaitk-saliency` package in various contexts using the Jupyter notebooks provided in the `./examples/` directory.\n\nContributions are encouraged! For more details, refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file.\n<!-- :auto getting-started: -->\n\n<!-- :auto documentation: -->\n## Documentation\nDocumentation for both release snapshots and the latest master branch is available on [ReadTheDocs](https://xaitk-saliency.readthedocs.io/en/latest/).\n\nTo build the Sphinx-based documentation locally for the latest reference:\n```bash\n# Install dependencies\npoetry install --sync --with main,linting,tests,docs\n# Navigate to the documentation root\ncd docs\n# Build the documentation\npoetry run make html\n# Open the generated documentation in your browser\nfirefox _build/html/index.html\n```\n<!-- :auto documentation: -->\n\n<!-- :auto developer-tools: -->\n## Developer Tools\n\n### Pre-commit Hooks\nPre-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.\n\nTo install and use pre-commit hooks:\n```bash\n# Install required dependencies\npoetry install --sync --with main,linting,tests,docs\n# Initialize pre-commit hooks for the repository\npoetry run pre-commit install\n# Run pre-commit checks on all files\npoetry run pre-commit run --all-files\n```\n<!-- :auto developer-tools: -->\n\n## XAITK Saliency Demonstration Tool\nThis [associated project](https://github.com/XAITK/xaitk-saliency-web-demo)\nprovides a local web-application that provides a demonstration of visual\nsaliency generation in a user-interface.\nThis provides an example of how visual saliency, as generated by this package,\ncan be utilized in a user-interface to facilitate model and results\nexploration.\nThis tool uses the [trame framework](https://kitware.github.io/trame/).\n\n| ![image1] | ![image2] | ![image3] | ![image4] |\n|:---------:|:---------:|:---------:|:---------:|\n\n[image1]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-classification-rise-4.jpg\n[image2]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-classification-sliding-window.jpg\n[image3]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-detection-retina.jpg\n[image4]: https://github.com/XAITK/xaitk-saliency-web-demo/blob/main/gallery/xaitk-similarity-1.jpg\n\n<!-- :auto license: -->\n## License\n[Apache 2.0](./LICENSE)\n<!-- :auto license: -->\n\nAll development prior to Nov 19, 2024 falls under [BSD-3-Clause](./LICENSE.old)\n\n<!-- :auto contacts: -->\n## Contacts\n\n**Principal Investigator**: Brian Hu (Kitware) @brian.hu\n\n**Product Owner**: Austin Whitesell (MITRE) @awhitesell\n\n**Scrum Master / Tech Lead**: Brandon RichardWebster (Kitware) @b.richardwebster\n\n**Deputy Tech Lead**: Emily Veenhuis (Kitware) @emily.veenhuis\n<!-- :auto contacts: -->\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Visual saliency map generation interfaces and baseline implementations for explainable AI.",
"version": "0.11.0",
"project_urls": {
"Documentation": "https://xaitk-saliency.readthedocs.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab49d0983c530e1eec09c2a4c8d5a3e755a16cee7371c122609c8fa797e5b873",
"md5": "3cea0cca8ed3bb2e91bba86c916a272b",
"sha256": "76bc2093519d1383c3aafcb842f4867421b40c2df77efde7ec3e08dd8476f4a8"
},
"downloads": -1,
"filename": "xaitk_saliency-0.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3cea0cca8ed3bb2e91bba86c916a272b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 70958,
"upload_time": "2025-01-12T00:28:55",
"upload_time_iso_8601": "2025-01-12T00:28:55.806592Z",
"url": "https://files.pythonhosted.org/packages/ab/49/d0983c530e1eec09c2a4c8d5a3e755a16cee7371c122609c8fa797e5b873/xaitk_saliency-0.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fced57ed1fea2259ec2df95c7392752dfc656e2db0449892a69540bced3635a5",
"md5": "67efe0416419f0879a9096a430977905",
"sha256": "89351aa4fa2bb900cacad794fe085740015bccf7748321f1f2aa24a07c388bfd"
},
"downloads": -1,
"filename": "xaitk_saliency-0.11.0.tar.gz",
"has_sig": false,
"md5_digest": "67efe0416419f0879a9096a430977905",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 44946,
"upload_time": "2025-01-12T00:28:58",
"upload_time_iso_8601": "2025-01-12T00:28:58.135047Z",
"url": "https://files.pythonhosted.org/packages/fc/ed/57ed1fea2259ec2df95c7392752dfc656e2db0449892a69540bced3635a5/xaitk_saliency-0.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-12 00:28:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xaitk-saliency"
}
