# NRTK EXPLORER
NRTK Explorer is a web application for exploring image datasets. It provides
insights of a image dataset in [COCO][3] format and it evaluate image
transformation and perturbation resilience of object recognition DL models. It
is built using [trame][1] by the [kitware][2] team.
## Features
- Explore image datasets in COCO format.
- Apply parametrized image degradation (such as blur) to the images.
- Benchmark dataset resilience with a differential PCA|UMAP analysis of the
embeddings of the images and its transformation.
- Evaluate object detection DL models in both the source images and its
transformations.
- When possible it will attempt to utilize the user GPU as much as possible to
speedup its computations.
## Installing
Install it from pypi:
```bash
pip install nrtk-explorer
```
## Usage
```bash
# get some sample data
git clone https://github.com/vicentebolea/nrtk_explorer_datasets.git
# Run the application on given dataset
nrtk-explorer --dataset ./nrtk_explorer_datasets/OIRDS_v1_0/oirds.json
```
Some COCO image datasets available at: https://github.com/vicentebolea/nrtk_explorer_datasets/
## CLI flags and options
- `-h|--help` show the help for the command line options, it inherit trame
command line options and flags.
- `--dataset` specify the path to a json file describing a COCO
image dataset. You can specify multiple COCO datasets using a comma `,` as a
separator. Example usage: `nrtk_explorer --dataset /foo-dir/coco.json, ../bar-dir/baz.json`
## Contribute to NRTK_EXPLORER
```bash
git clone https://github.com/Kitware/nrtk-explorer.git
cd nrtk-explorer
python3 -m venv .venv
source .venv/bin/activate
pip install -U pip
pip install -e '.[dev]'
pytest .
```
For more details on setting up a development environment see [DEVELOPMENT docs](docs/source/manual/DEVELOPMENT.rst).
[1]: https://trame.readthedocs.io/en/latest/
[2]: https://www.kitware.com/
[3]: https://cocodataset.org/
### Create release
1. Merge `main` to `release` with a _merge commit_.
2. Run "Create Release" workflow with workflow from `release` branch.
3. Merge `release` to `main` with a _merge commit_.
Raw data
{
"_id": null,
"home_page": null,
"name": "nrtk-explorer",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Application, Framework, Interactive, Python, Web",
"author": null,
"author_email": "Alessandro Genova <alessandro.genova@kitware.com>, Vicente Adolfo Bolea Sanchez <vicente.bolea@kitware.com>",
"download_url": "https://files.pythonhosted.org/packages/8a/31/bf732d500777b688f942646803c66c5aadf11293f35997bed4108ac14aeb/nrtk_explorer-0.5.0.tar.gz",
"platform": null,
"description": "# NRTK EXPLORER\n\nNRTK Explorer is a web application for exploring image datasets. It provides\ninsights of a image dataset in [COCO][3] format and it evaluate image\ntransformation and perturbation resilience of object recognition DL models. It\nis built using [trame][1] by the [kitware][2] team.\n\n\n\n## Features\n\n- Explore image datasets in COCO format.\n- Apply parametrized image degradation (such as blur) to the images.\n- Benchmark dataset resilience with a differential PCA|UMAP analysis of the\n embeddings of the images and its transformation.\n- Evaluate object detection DL models in both the source images and its\n transformations.\n- When possible it will attempt to utilize the user GPU as much as possible to\n speedup its computations.\n\n## Installing\n\nInstall it from pypi:\n\n```bash\npip install nrtk-explorer\n```\n\n## Usage\n\n```bash\n# get some sample data\ngit clone https://github.com/vicentebolea/nrtk_explorer_datasets.git\n\n# Run the application on given dataset\nnrtk-explorer --dataset ./nrtk_explorer_datasets/OIRDS_v1_0/oirds.json\n```\n\n\n\nSome COCO image datasets available at: https://github.com/vicentebolea/nrtk_explorer_datasets/\n\n## CLI flags and options\n\n- `-h|--help` show the help for the command line options, it inherit trame\n command line options and flags.\n- `--dataset` specify the path to a json file describing a COCO\n image dataset. You can specify multiple COCO datasets using a comma `,` as a\n separator. Example usage: `nrtk_explorer --dataset /foo-dir/coco.json, ../bar-dir/baz.json`\n\n## Contribute to NRTK_EXPLORER\n\n```bash\ngit clone https://github.com/Kitware/nrtk-explorer.git\ncd nrtk-explorer\npython3 -m venv .venv\nsource .venv/bin/activate\npip install -U pip\npip install -e '.[dev]'\npytest .\n```\n\nFor more details on setting up a development environment see [DEVELOPMENT docs](docs/source/manual/DEVELOPMENT.rst).\n\n[1]: https://trame.readthedocs.io/en/latest/\n[2]: https://www.kitware.com/\n[3]: https://cocodataset.org/\n\n### Create release\n\n1. Merge `main` to `release` with a _merge commit_.\n2. Run \"Create Release\" workflow with workflow from `release` branch.\n3. Merge `release` to `main` with a _merge commit_.\n",
"bugtrack_url": null,
"license": null,
"summary": "Model Visualizer",
"version": "0.5.0",
"project_urls": null,
"split_keywords": [
"application",
" framework",
" interactive",
" python",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d2abe5bbc6d71701fd62a0c772954cd52ea1211f459129a07df34015c8fa7f4",
"md5": "5738cc6f036cef1c089754118c7161c5",
"sha256": "2969783c10bbecc42e642296c52f2b1a345788cc3a89074f1b3a19b00a95f197"
},
"downloads": -1,
"filename": "nrtk_explorer-0.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5738cc6f036cef1c089754118c7161c5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 3524313,
"upload_time": "2024-10-21T22:00:37",
"upload_time_iso_8601": "2024-10-21T22:00:37.510180Z",
"url": "https://files.pythonhosted.org/packages/2d/2a/be5bbc6d71701fd62a0c772954cd52ea1211f459129a07df34015c8fa7f4/nrtk_explorer-0.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8a31bf732d500777b688f942646803c66c5aadf11293f35997bed4108ac14aeb",
"md5": "e3f6df71046b13812d00785533e91bfa",
"sha256": "bd0908de96deed16e33523a9a2b890a688931a39eaa1042bf976952541d75e04"
},
"downloads": -1,
"filename": "nrtk_explorer-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "e3f6df71046b13812d00785533e91bfa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7140070,
"upload_time": "2024-10-21T22:00:39",
"upload_time_iso_8601": "2024-10-21T22:00:39.713339Z",
"url": "https://files.pythonhosted.org/packages/8a/31/bf732d500777b688f942646803c66c5aadf11293f35997bed4108ac14aeb/nrtk_explorer-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 22:00:39",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nrtk-explorer"
}
JSON