Metadata-Version: 2.1
Name: ueagents
Version: 1.0.0
Summary: Unreal Machine Learning Agents based on Unity ML Agents
Author: Stephane Capponi
License: Apache Software License
Project-URL: Homepage, https://github.com/AlanLaboratory/UnrealMLAgents
Requires-Python: <=3.10.12,>=3.10.1
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: LICENSE.unity
Requires-Dist: h5py>=2.9.0
Requires-Dist: tensorboard>=2.14
Requires-Dist: torch==2.4.1
Requires-Dist: ueagents-envs==1.0.0
Requires-Dist: six>=1.16
Requires-Dist: attrs>=19.3.0
Requires-Dist: huggingface-hub>=0.14
Requires-Dist: onnx==1.15.0
Requires-Dist: pypiwin32==223; platform_system == "Windows"
Requires-Dist: cattrs<1.7,>=1.1.0; python_version >= "3.8"

# Unreal ML-Agents Trainers

The `ueagents` Python package is part of the Unreal ML-Agents Toolkit. `ueagents`
provides a set of reinforcement and imitation learning algorithms designed to be
used with Unreal Engine environments. The algorithms interface with the Python API
provided by the `ueagents_envs` package.

## Notice

This package is inspired by Unity's ML-Agents Toolkit. The primary differences are:
- `ueagents` has been updated to import from `ueagents_envs` instead of `mlagents_envs`.
- Changes were made to support Unreal Engine, with references to Unity replaced with Unreal.
- SideChannels are not supported yet, and the code has been adjusted accordingly.

All credit for the foundational work goes to Unity's ML-Agents Toolkit team.

## Installation

Install the `ueagents` package with:

```sh
python -m pip install ueagents
```

## Usage & More Information

For more information on the Unreal ML-Agents Toolkit and how to instrument an Unreal
scene with the Unreal ML-Agents SDK, check out the main
[Unreal ML-Agents Toolkit documentation](https://unrealmlagents.readthedocs.io/en/latest/).

## Credit

[Unity ML Agents](https://github.com/Unity-Technologies/ml-agents)
