| Name | nrtk-jatic JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2024-12-14 03:18:43 |
| 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.
|
<!-- :auto badges: -->
[](https://pypi.org/project/nrtk-jatic/)
[](https://nrtk-jatic.readthedocs.io/en/latest/?badge=latest)
<!-- :auto badges: -->
# nrtk-jatic
The `nrtk-jatic` package is an extension of the Natural Robustness Toolkit
([NRTK](https://github.com/Kitware/nrtk)) containing implementations
and examples in compliance with protocols from the Modular AI Trustworthy Engineering
([MAITE](https://github.com/mit-ll-ai-technology/maite)) library.
These packages (among others) are developed under the
[Joint AI Test Infrastructure Capability (JATIC) program](https://cdao.pages.jatic.net/public/)
for AI Test & Evaluation (T&E) and AI Assurance.
## Interoperability - Implementations and Examples
The `nrtk-jatic` package consists of implementations and utilities that ensure
interoperability of `nrtk` functionality with `maite`. The scripts under
`src/nrtk_jatic/interop` consist of protocol implementations that are compliant
with `maite`'s dataset and augmentation protocols. The `src/nrtk_jatic/utils`
folder houses generic util scripts and the NRTK CLI entrypoint script.
Finally, the `examples` folder consists of Jupyter notebooks showing
end-to-end ML T&E workflows demonstrating natural robustness testing of computer vision models with `nrtk`,
and integrations of `nrtk` with other JATIC tools,
by using the interoperability standards provided by `maite`
Additional information about JATIC and its design principles can be found
[here](https://cdao.pages.jatic.net/public/program/design-principles/).
<!-- :auto installation: -->
## Installation
Ensure the source tree is acquired locally before proceeding.
To install the current version via `pip`:
```bash
pip install nrtk-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://nrtk-jatic.readthedocs.io/en/latest/implementations.html).
For more detailed installation instructions, visit the [installation documentation](https://nrtk-jatic.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->
<!-- :auto getting-started: -->
## Getting Started
Explore usage examples of the `nrtk-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://nrtk-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: -->
Raw data
{
"_id": null,
"home_page": null,
"name": "nrtk-jatic",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Kitware, Inc.",
"author_email": "nrtk@kitware.com",
"download_url": "https://files.pythonhosted.org/packages/06/9a/5b32758c85f714df57a7bd934f9361d1a2496baf54dbe03956ae92dc75da/nrtk_jatic-0.4.0.tar.gz",
"platform": null,
"description": "<!-- :auto badges: -->\n[](https://pypi.org/project/nrtk-jatic/)\n\n[](https://nrtk-jatic.readthedocs.io/en/latest/?badge=latest)\n<!-- :auto badges: -->\n\n# nrtk-jatic\n\nThe `nrtk-jatic` package is an extension of the Natural Robustness Toolkit\n([NRTK](https://github.com/Kitware/nrtk)) containing implementations\nand examples in compliance with protocols from the Modular AI Trustworthy Engineering\n([MAITE](https://github.com/mit-ll-ai-technology/maite)) library.\nThese packages (among others) are developed under the\n[Joint AI Test Infrastructure Capability (JATIC) program](https://cdao.pages.jatic.net/public/)\nfor AI Test & Evaluation (T&E) and AI Assurance.\n\n## Interoperability - Implementations and Examples\n\nThe `nrtk-jatic` package consists of implementations and utilities that ensure\ninteroperability of `nrtk` functionality with `maite`. The scripts under\n`src/nrtk_jatic/interop` consist of protocol implementations that are compliant\nwith `maite`'s dataset and augmentation protocols. The `src/nrtk_jatic/utils`\nfolder houses generic util scripts and the NRTK CLI entrypoint script.\nFinally, the `examples` folder consists of Jupyter notebooks showing\nend-to-end ML T&E workflows demonstrating natural robustness testing of computer vision models with `nrtk`,\nand integrations of `nrtk` with other JATIC tools,\nby using the interoperability standards provided by `maite`\n\nAdditional information about JATIC and its design principles can be found\n[here](https://cdao.pages.jatic.net/public/program/design-principles/).\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 nrtk-jatic\n```\n\nAlternatively, you can use [Poetry](https://python-poetry.org/):\n```bash\npoetry install\n```\n\nCertain plugins may require additional runtime dependencies. Details on these requirements can be found [here](https://nrtk-jatic.readthedocs.io/en/latest/implementations.html).\n\nFor more detailed installation instructions, visit the [installation documentation](https://nrtk-jatic.readthedocs.io/en/latest/installation.html).\n<!-- :auto installation: -->\n\n<!-- :auto getting-started: -->\n## Getting Started\nExplore usage examples of the `nrtk-jatic` 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://nrtk-jatic.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 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 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<!-- :auto contributing: -->\n## Contributing\n- Follow the [JATIC Design Principles](https://cdao.pages.jatic.net/public/program/design-principles/).\n- Adopt the Git Flow branching strategy.\n- Detailed release information is available in [docs/release_process.rst](./docs/release_process.rst).\n- Additional contribution guidelines can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).\n<!-- :auto contributing: -->\n\n<!-- :auto license: -->\n## License\n[Apache 2.0](./LICENSE)\n<!-- :auto license: -->\n\n<!-- :auto contacts: -->\n## Contacts\n\n**Principal Investigator**: Brian Hu (Kitware) @brian.hu\n**Product Owner**: Austin Whitesell (MITRE) @awhitesell\n**Scrum Master / Tech Lead**: Brandon RichardWebster (Kitware) @b.richardwebster\n**Deputy Tech Lead**: Emily Veenhuis (Kitware) @emily.veenhuis\n<!-- :auto contacts: -->",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": null,
"version": "0.4.0",
"project_urls": {
"Documentation": "https://nrtk-jatic.readthedocs.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "443590afd929fd7edd1fce151f0311dbb6d460a57d8056e6ac0d9fd53b041c05",
"md5": "0e84a59e740902574712e7d6d3ac3cb1",
"sha256": "ca2e1464cdcf06c7b20110bae8854988187293d02bf8b845e38eeeaa0e376cfd"
},
"downloads": -1,
"filename": "nrtk_jatic-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e84a59e740902574712e7d6d3ac3cb1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 24089,
"upload_time": "2024-12-14T03:18:40",
"upload_time_iso_8601": "2024-12-14T03:18:40.688929Z",
"url": "https://files.pythonhosted.org/packages/44/35/90afd929fd7edd1fce151f0311dbb6d460a57d8056e6ac0d9fd53b041c05/nrtk_jatic-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "069a5b32758c85f714df57a7bd934f9361d1a2496baf54dbe03956ae92dc75da",
"md5": "79ea5e7ee8b0d10ec0649542565f84e4",
"sha256": "44b21678175597c569e699cc24387447946fa3137b192c0d128d0ee8f0c87a38"
},
"downloads": -1,
"filename": "nrtk_jatic-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "79ea5e7ee8b0d10ec0649542565f84e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 20520,
"upload_time": "2024-12-14T03:18:43",
"upload_time_iso_8601": "2024-12-14T03:18:43.019209Z",
"url": "https://files.pythonhosted.org/packages/06/9a/5b32758c85f714df57a7bd934f9361d1a2496baf54dbe03956ae92dc75da/nrtk_jatic-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-14 03:18:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nrtk-jatic"
}
