nrtk-jatic

Name	nrtk-jatic JSON
Version	0.2.0 JSON
	download
home_page	None
Summary	None
upload_time	2024-10-15 20:57:11
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.

            # 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
The following steps assume the source tree has been acquired locally.

Install the current version via pip:
```bash
pip install nrtk-jatic
```

Alternatively, you can also use [Poetry](https://python-poetry.org/):
```bash
poetry install --sync --with dev-linting,dev-testing,dev-docs
```

See [here for more installation documentation](
https://nrtk-jatic.readthedocs.io/en/latest/installation.html).
<!-- :auto installation: -->

<!-- :auto getting-started: -->
## Getting Started
We provide a number of examples based on Jupyter notebooks in the
`./examples/` directory to show usage of the `nrtk-jatic` package in a number
of different contexts.
<!-- :auto getting-started: -->

<!-- :auto documentation: -->
## Documentation
Documentation snapshots for releases as well as the latest master are hosted
on [ReadTheDocs](https://nrtk-jatic.readthedocs.io/en/latest/).

The sphinx-based documentation may also be built locally for the most
up-to-date reference:
```bash
# 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
```
<!-- :auto documentation: -->

<!-- :auto developer-tools: -->
## 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:
```bash
# 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
```
<!-- :auto developer-tools: -->

<!-- :auto contributing: -->
## Contributing
- We follow the general guidelines outlined in the
[JATIC Software Development Plan](https://gitlab.jatic.net/jatic/docs/sdp/-/blob/main/Branch,%20Merge,%20Release%20Strategy.md).
- We use the Git Flow branching strategy.
- See [docs/release_process.rst](./docs/release_process.rst) for detailed release information.
- See [CONTRIBUTING.md](./CONTRIBUTING.md) for additional contributing information.
<!-- :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/c1/67/237b660fcb664d6c06583587880d84781fad8e43c486582340fba0fbadc3/nrtk_jatic-0.2.0.tar.gz",
    "platform": null,
    "description": "# 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\nThe following steps assume the source tree has been acquired locally.\n\nInstall the current version via pip:\n```bash\npip install nrtk-jatic\n```\n\nAlternatively, you can also use [Poetry](https://python-poetry.org/):\n```bash\npoetry install --sync --with dev-linting,dev-testing,dev-docs\n```\n\nSee [here for more installation documentation](\nhttps://nrtk-jatic.readthedocs.io/en/latest/installation.html).\n<!-- :auto installation: -->\n\n<!-- :auto getting-started: -->\n## Getting Started\nWe provide a number of examples based on Jupyter notebooks in the\n`./examples/` directory to show usage of the `nrtk-jatic` package in a number\nof different contexts.\n<!-- :auto getting-started: -->\n\n<!-- :auto documentation: -->\n## Documentation\nDocumentation snapshots for releases as well as the latest master are hosted\non [ReadTheDocs](https://nrtk-jatic.readthedocs.io/en/latest/).\n\nThe sphinx-based documentation may also be built locally for the most\nup-to-date reference:\n```bash\n# Install dependencies\npoetry install --sync --with dev-linting,dev-testing,dev-docs\n# Navigate to the documentation root.\ncd docs\n# Build the docs.\npoetry run make html\n# Open in your favorite 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 are used to ensure that any code meets all linting and\nformatting guidelines required. After installing, this will always run before\n committing to ensure that any commits are following the standards, but you\n can also manually run the check without committing. If you want to commit\n despite there being errors, you can add `--no-verify` to your commit command.\n\nInstalling pre-commit hooks:\n```bash\n# Ensure that all dependencies are installed\npoetry install --sync --with dev-linting,dev-testing,dev-docs\n# Initialize pre-commit for the repository\npoetry run pre-commit install\n# Run pre-commit check on all files\npoetry run pre-commit run --all-files\n```\n<!-- :auto developer-tools: -->\n\n<!-- :auto contributing: -->\n## Contributing\n- We follow the general guidelines outlined in the\n[JATIC Software Development Plan](https://gitlab.jatic.net/jatic/docs/sdp/-/blob/main/Branch,%20Merge,%20Release%20Strategy.md).\n- We use the Git Flow branching strategy.\n- See [docs/release_process.rst](./docs/release_process.rst) for detailed release information.\n- See [CONTRIBUTING.md](./CONTRIBUTING.md) for additional contributing information.\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\n<!-- :auto contacts: -->\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": null,
    "version": "0.2.0",
    "project_urls": {
        "Documentation": "https://nrtk-jatic.readthedocs.io/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f033d2b2921a1a19ccde0794b4e2bd722b7191526d6d6ae415f773a36dbf5efb",
                "md5": "e9e5ae0fd757e9e900077642e3c4f6ae",
                "sha256": "84dfb7861c97ce9f13af44e8a200a0cf54064f75dffd73994abfe7742829b29e"
            },
            "downloads": -1,
            "filename": "nrtk_jatic-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e9e5ae0fd757e9e900077642e3c4f6ae",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 22935,
            "upload_time": "2024-10-15T20:57:09",
            "upload_time_iso_8601": "2024-10-15T20:57:09.819721Z",
            "url": "https://files.pythonhosted.org/packages/f0/33/d2b2921a1a19ccde0794b4e2bd722b7191526d6d6ae415f773a36dbf5efb/nrtk_jatic-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c167237b660fcb664d6c06583587880d84781fad8e43c486582340fba0fbadc3",
                "md5": "b5c00a180307efe0f6c19ee444f30c25",
                "sha256": "2405efecd75bf6dc1f380e96b868a1c3b52b241bf609ae349910602db0e89705"
            },
            "downloads": -1,
            "filename": "nrtk_jatic-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b5c00a180307efe0f6c19ee444f30c25",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 19529,
            "upload_time": "2024-10-15T20:57:11",
            "upload_time_iso_8601": "2024-10-15T20:57:11.640753Z",
            "url": "https://files.pythonhosted.org/packages/c1/67/237b660fcb664d6c06583587880d84781fad8e43c486582340fba0fbadc3/nrtk_jatic-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-15 20:57:11",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "nrtk-jatic"
}

Kitware, Inc.