Metadata-Version: 2.4
Name: neatrl
Version: 0.1.2
Summary: A Python library for reinforcement learning algorithms
Author-email: Yuvraj Singh <yuvrajsingh9886@example.com>
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: torch
Requires-Dist: numpy
Requires-Dist: gymnasium
Requires-Dist: stable-baselines3
Requires-Dist: tqdm
Requires-Dist: wandb
Requires-Dist: huggingface_hub
Requires-Dist: imageio
Requires-Dist: opencv-python
Requires-Dist: imageio[ffmpeg]
Provides-Extra: dev
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Dynamic: license-file

# neatrl

[![CI](https://github.com/YuvrajSingh-mist/NeatRL/actions/workflows/ci.yml/badge.svg)](https://github.com/YuvrajSingh-mist/NeatRL/actions/workflows/ci.yml)
[![PyPI version](https://badge.fury.io/py/neatrl.svg)](https://pypi.org/project/neatrl/)

A Python library for reinforcement learning algorithms.

## Installation

```bash
pip install -e .
```

For development:
```bash
pip install -e .[dev]
```

## Usage

Import the components:

```python
from neatrl import QNet, LinearEpsilonDecay, make_env, evaluate
```

To run the DQN training script:

```bash
python -m neatrl.dqn
```

## Development

```bash
# Install dev dependencies
make install-dev

# Run all checks
make all

# Run tests
make test

# Lint and format
make lint
make format

# Type check
make type-check

# Build package
make build
```

Or directly:

```bash
python neatrl/src/neatrl/dqn.py
```
