# 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 on the
embeddings of the images and their transformations.
- 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
Explore Hugging Face hosted [dataset](https://huggingface.co/datasets/rafaelpadilla/coco2017):
```bash
nrtk-explorer --dataset rafaelpadilla/coco2017
```
Compare inference results for Hugging Face hosted models:
```bash
nrtk-explorer --dataset cppe-5 --models qubvel-hf/detr-resnet-50-finetuned-10k-cppe5 ashaduzzaman/detr_finetuned_cppe5
```
2 COCO format datasets are available at: https://github.com/vicentebolea/nrtk_explorer_datasets/
```bash
git clone https://github.com/vicentebolea/nrtk_explorer_datasets.git
nrtk-explorer --dataset ./nrtk_explorer_datasets/coco-od-2017/mini_val2017.json ./nrtk_explorer_datasets/OIRDS_v1_0/oirds.json
```
## CLI flags and options
- `--dataset` specify the path to a [COCO dataset](https://roboflow.com/formats/coco-json) JSON file,
a [Hugging Face dataset](https://huggingface.co/datasets?task_categories=task_categories:object-detection) repository name,
or a directory loadable by the [Dataset](https://huggingface.co/docs/datasets/index) library.
You can specify multiple datasets using a space as the
separator. Example: `nrtk-explorer --dataset ../foo-dir/coco.json cppe-5`
- `--download` Cache Hugging Face Hub datasets locally instead of streaming them.
When datasets are streamed, nrtk-explorer limits the number of loaded images.
- `--models` specify the Hugging Face Hub [object detection](https://huggingface.co/models?pipeline_tag=object-detection&library=transformers&sort=trending)
repository name or a directory loadable by the [Transformers](https://huggingface.co/docs/transformers/index) library. Load multiple models using space as the separator.
Example: `nrtk-explorer --models hustvl/yolos-tiny facebook/detr-resnet-50`
- `-h|--help` show the help for the command line options. nrtk-explorer inherits the trame
command line options and flags.
## 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).
### 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_.
[1]: https://trame.readthedocs.io/en/latest/
[2]: https://www.kitware.com/
[3]: https://cocodataset.org/
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/a4/1a/60da12803c1d57e8cdcc6568f1bcba2fb8d9be549551fbe9f633efed7be2/nrtk_explorer-0.7.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 on the\n embeddings of the images and their transformations.\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\nExplore Hugging Face hosted [dataset](https://huggingface.co/datasets/rafaelpadilla/coco2017):\n\n```bash\nnrtk-explorer --dataset rafaelpadilla/coco2017\n```\n\nCompare inference results for Hugging Face hosted models:\n\n```bash\nnrtk-explorer --dataset cppe-5 --models qubvel-hf/detr-resnet-50-finetuned-10k-cppe5 ashaduzzaman/detr_finetuned_cppe5\n```\n\n2 COCO format datasets are available at: https://github.com/vicentebolea/nrtk_explorer_datasets/\n\n```bash\ngit clone https://github.com/vicentebolea/nrtk_explorer_datasets.git\nnrtk-explorer --dataset ./nrtk_explorer_datasets/coco-od-2017/mini_val2017.json ./nrtk_explorer_datasets/OIRDS_v1_0/oirds.json\n```\n\n## CLI flags and options\n\n- `--dataset` specify the path to a [COCO dataset](https://roboflow.com/formats/coco-json) JSON file,\n a [Hugging Face dataset](https://huggingface.co/datasets?task_categories=task_categories:object-detection) repository name,\n or a directory loadable by the [Dataset](https://huggingface.co/docs/datasets/index) library.\n You can specify multiple datasets using a space as the\n separator. Example: `nrtk-explorer --dataset ../foo-dir/coco.json cppe-5`\n- `--download` Cache Hugging Face Hub datasets locally instead of streaming them.\n When datasets are streamed, nrtk-explorer limits the number of loaded images.\n- `--models` specify the Hugging Face Hub [object detection](https://huggingface.co/models?pipeline_tag=object-detection&library=transformers&sort=trending)\n repository name or a directory loadable by the [Transformers](https://huggingface.co/docs/transformers/index) library. Load multiple models using space as the separator. \n Example: `nrtk-explorer --models hustvl/yolos-tiny facebook/detr-resnet-50`\n- `-h|--help` show the help for the command line options. nrtk-explorer inherits the trame\n command line options and flags.\n\n\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### 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\n[1]: https://trame.readthedocs.io/en/latest/\n[2]: https://www.kitware.com/\n[3]: https://cocodataset.org/\n",
"bugtrack_url": null,
"license": null,
"summary": "Model Visualizer",
"version": "0.7.0",
"project_urls": null,
"split_keywords": [
"application",
" framework",
" interactive",
" python",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba3371fc77ac5b2718da7c0b2eb7af97ef949620f92a4a7c4a2df209d3dffbc5",
"md5": "023b0df57b61cb09f388cefad521f2f0",
"sha256": "e850638afba9c650f59e66c2320d409e3c716deda107af0753ac86d6557a3c20"
},
"downloads": -1,
"filename": "nrtk_explorer-0.7.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "023b0df57b61cb09f388cefad521f2f0",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 3516389,
"upload_time": "2024-12-17T17:49:27",
"upload_time_iso_8601": "2024-12-17T17:49:27.634813Z",
"url": "https://files.pythonhosted.org/packages/ba/33/71fc77ac5b2718da7c0b2eb7af97ef949620f92a4a7c4a2df209d3dffbc5/nrtk_explorer-0.7.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a41a60da12803c1d57e8cdcc6568f1bcba2fb8d9be549551fbe9f633efed7be2",
"md5": "336c11995717f10b85c6430c7cb03682",
"sha256": "9d9303a6892418561a1fd85a2c0995608647e07d0bbcb7c2a9bebdc21c6bcabf"
},
"downloads": -1,
"filename": "nrtk_explorer-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "336c11995717f10b85c6430c7cb03682",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7134757,
"upload_time": "2024-12-17T17:49:29",
"upload_time_iso_8601": "2024-12-17T17:49:29.604236Z",
"url": "https://files.pythonhosted.org/packages/a4/1a/60da12803c1d57e8cdcc6568f1bcba2fb8d9be549551fbe9f633efed7be2/nrtk_explorer-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 17:49:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nrtk-explorer"
}
JSON