Metadata-Version: 2.4
Name: imagenet-classes
Version: 0.1.2
Summary: A Python package for managing and retrieving ImageNet-1k mappings among integer class IDs, string class IDs, and human-readable class names.
Home-page: https://github.com/gonikisgo/imagenet-classes
Author: Illia Volkov, Nikita Kisel
Author-email: Illia Volkov <volkoill@cvut.cz>, Nikita Kisel <kiselnik@fel.cvut.cz>
Maintainer-email: Nikita Kisel <kiselnik@fel.cvut.cz>
License: MIT
Project-URL: Homepage, https://github.com/gonikisgo/imagenet-classes
Project-URL: Documentation, https://github.com/gonikisgo/imagenet-classes#readme
Project-URL: Repository, https://github.com/gonikisgo/imagenet-classes
Project-URL: Bug Tracker, https://github.com/gonikisgo/imagenet-classes/issues
Keywords: imagenet,computer-vision,machine-learning,deep-learning,classification
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Typed
Classifier: Framework :: Pytest
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.19.0
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: pytest-cov>=2.0; extra == "dev"
Requires-Dist: black>=21.0; extra == "dev"
Requires-Dist: flake8>=3.8; extra == "dev"
Requires-Dist: mypy>=0.800; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# ImageNet Classes

A Python package for managing and retrieving ImageNet-1k (ImageNet2012) class names and mappings.

## Installation

### From PyPI (when published)
```bash
pip install imagenet-classes
```

### From Source
```bash
git clone https://github.com/gonikisgo/imagenet-classes.git
cd imagenet-classes
pip install -e .
```

## Quick Start

```python
from class_mapping import ClassDictionary

# Initialize the class dictionary
class_dict = ClassDictionary()

# Get class name for ImageNet-1k class index 0
class_name = class_dict.get_class_name(0)
print(f"Class 0: {class_name}")

# Get ImageNet21k to ImageNet-1k class mapping
class_1k = class_dict.get_class_1k("n01440764")
print(f"Class 1k mapping: {class_1k}")

# Get custom class name
custom_name = class_dict.get_custom_class_name(0)
print(f"Custom name: {custom_name}")
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Support

For support, please open an issue on the [GitHub repository](https://github.com/gonikisgo/imagenet-classes/issues).
