| Name | nrtk JSON |
| Version |
0.20.0
JSON |
| download |
| home_page | None |
| Summary | Natural Robustness Toolkit (NRTK) is a platform for generating validated, sensor-specific perturbations and transformations used to evaluate the robustness of computer vision models. |
| upload_time | 2025-02-26 19:56:02 |
| 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/)
[](https://nrtk.readthedocs.io/en/latest/?badge=latest)
<!-- :auto badges: -->
# Natural Robustness Toolkit (NRTK)
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](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.
We have also created the [`nrtk-jatic`](https://github.com/Kitware/nrtk-jatic) package to support AI T&E
use-cases and workflows, through interoperability with the [`maite`](https://github.com/mit-ll-ai-technology/maite)
library and integration with other [JATIC](https://cdao.pages.jatic.net/public/) tools. Users seeking to use NRTK to
perturb MAITE-wrapped datasets or evaluate MAITE-wrapped models should
start with the `nrtk-jatic` package.
<!-- :auto installation: -->
## Installation
Ensure the source tree is acquired locally before proceeding.
To install the current version via `pip`:
```bash
pip install nrtk[<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://nrtk.readthedocs.io/en/latest/implementations.html).
For more detailed installation instructions, visit the [installation documentation](https://nrtk.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->
<!-- :auto getting-started: -->
## Getting Started
Explore usage examples of the `nrtk` package in various contexts using the Jupyter notebooks provided in the `./docs/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.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: -->
<!-- :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 and issue reporting steps 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",
"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/f9/38/d80b1023dc17027da642230f28594d7a930fd5a7809c1496ce319b4f9800/nrtk-0.20.0.tar.gz",
"platform": null,
"description": "<!-- :auto badges: -->\n[](https://pypi.org/project/nrtk/)\n\n[](https://nrtk.readthedocs.io/en/latest/?badge=latest)\n<!-- :auto badges: -->\n\n# Natural Robustness Toolkit (NRTK)\n\nThe `nrtk` package is an open source toolkit for evaluating the natural robustness of computer vision\nalgorithms to various perturbations, including sensor-specific changes to camera focal length, aperture\ndiameter, etc. Functionality is provided through [Strategy](https://en.wikipedia.org/wiki/Strategy_pattern)\nand [Adapter](https://en.wikipedia.org/wiki/Adapter_pattern) patterns to allow for modular integration\ninto systems and applications.\n\nWe have also created the [`nrtk-jatic`](https://github.com/Kitware/nrtk-jatic) package to support AI T&E\nuse-cases and workflows, through interoperability with the [`maite`](https://github.com/mit-ll-ai-technology/maite)\nlibrary and integration with other [JATIC](https://cdao.pages.jatic.net/public/) tools. Users seeking to use NRTK to\nperturb MAITE-wrapped datasets or evaluate MAITE-wrapped models should\nstart with the `nrtk-jatic` package.\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[<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://nrtk.readthedocs.io/en/latest/implementations.html).\n\nFor more detailed installation instructions, visit the [installation documentation](https://nrtk.readthedocs.io/en/latest/installation.html).\n<!-- :auto installation: -->\n\n<!-- :auto getting-started: -->\n## Getting Started\nExplore usage examples of the `nrtk` package in various contexts using the Jupyter notebooks provided in the `./docs/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.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<!-- :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 and issue reporting steps 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\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: -->",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Natural Robustness Toolkit (NRTK) is a platform for generating validated, sensor-specific perturbations and transformations used to evaluate the robustness of computer vision models.",
"version": "0.20.0",
"project_urls": {
"Documentation": "https://nrtk.readthedocs.io/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf6df5c54bbc3a65827f119cc06095dcad32ef92f1785bf488070d3e060f57bf",
"md5": "a31da7e2dc3ac2351705c3ad6aeb8d62",
"sha256": "8189d134dad0f42d5d1a007a4713e5b6c25b0f84662a4c3ba401bdf9f6371ed2"
},
"downloads": -1,
"filename": "nrtk-0.20.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a31da7e2dc3ac2351705c3ad6aeb8d62",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 111107,
"upload_time": "2025-02-26T19:56:00",
"upload_time_iso_8601": "2025-02-26T19:56:00.089281Z",
"url": "https://files.pythonhosted.org/packages/bf/6d/f5c54bbc3a65827f119cc06095dcad32ef92f1785bf488070d3e060f57bf/nrtk-0.20.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f938d80b1023dc17027da642230f28594d7a930fd5a7809c1496ce319b4f9800",
"md5": "5c61f17bbe3662cc05e13d3914045f8f",
"sha256": "b824366a6bf3c49ad15329ac3c049294cee9ff0bd724bc02c58ca97095e867f7"
},
"downloads": -1,
"filename": "nrtk-0.20.0.tar.gz",
"has_sig": false,
"md5_digest": "5c61f17bbe3662cc05e13d3914045f8f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 67111,
"upload_time": "2025-02-26T19:56:02",
"upload_time_iso_8601": "2025-02-26T19:56:02.171460Z",
"url": "https://files.pythonhosted.org/packages/f9/38/d80b1023dc17027da642230f28594d7a930fd5a7809c1496ce319b4f9800/nrtk-0.20.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-26 19:56:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nrtk"
}
