Metadata-Version: 2.1
Name: nn-zoo
Version: 1.0.2
Summary: A collection of PyTorch utilities
Author-email: Kara Ravindra <contact@karanravindra.me>
License: MIT
Keywords: pytorch,machine-learning,deep-learning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: lightning
Requires-Dist: torchvision
Requires-Dist: lightning
Requires-Dist: einops
Requires-Dist: wandb
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: ruff; extra == "dev"

# nn-zoo

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/nn-zoo)
![PyPI - Version](https://img.shields.io/pypi/v/nn-zoo)
![PyPI - License](https://img.shields.io/pypi/l/nn-zoo)

## Overview

This repository contains a collection reusable machine learning models and utilities. The goal is to provide a set of tools that can be easily integrated into other projects. The models are implemented using PyTorch and are designed to be easily extended and modified. Inspired by projects like [Hugging Face Transformers](https://github.com/huggingface/transformers) and [PyTorch Lightning](https://github.com/Lightning-AI/pytorch-lightning).

## Table of Contents

- [Overview](#overview)
- [Installation](#installation)
- [Contributing](#contributing)
- [License](#license)

## Installation

To install the package, run the following command:

```bash
pip install nn-zoo
```

## Contributing

Contributions are welcome! For bug reports or requests please submit an issue.
To install the package in development mode, run the following command:

```bash
git clone https://github.com/karanravindra/nn-zoo.git
cd nn-zoo
pip install -e '.[dev]'
```

## License

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