https://github.com/alanlaboratory/unrealmlagents
The Unreal ML Agents Toolkit is an open-source project that enables Unreal Engine games and simulations to serve as environments for training intelligent agents using deep reinforcement learning. This project is a port of Unity ML-Agents, adapted to work within Unreal Engine.
https://github.com/alanlaboratory/unrealmlagents
artificial-intelligence deep-learning deep-reinforcement-learning machine-learning neural-network reinforcement-learning unreal-engine unreal-engine-5 unreal-engine-plugin
Last synced: 10 months ago
JSON representation
The Unreal ML Agents Toolkit is an open-source project that enables Unreal Engine games and simulations to serve as environments for training intelligent agents using deep reinforcement learning. This project is a port of Unity ML-Agents, adapted to work within Unreal Engine.
- Host: GitHub
- URL: https://github.com/alanlaboratory/unrealmlagents
- Owner: AlanLaboratory
- License: other
- Created: 2024-06-08T19:37:29.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-13T21:38:08.000Z (over 1 year ago)
- Last Synced: 2025-09-07T10:48:52.985Z (10 months ago)
- Topics: artificial-intelligence, deep-learning, deep-reinforcement-learning, machine-learning, neural-network, reinforcement-learning, unreal-engine, unreal-engine-5, unreal-engine-plugin
- Language: Python
- Homepage:
- Size: 17.4 MB
- Stars: 50
- Watchers: 3
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: Docs/README.md
- Changelog: Changelog/.gitignore
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
- Authors: AUTHORS
- Notice: NOTICE.md
Awesome Lists containing this project
README
# Unreal ML Agents Documentation
You want to learn more about Unreal ML Agents? You are at the right place! This section will help you generate the
documentation so you can read it in your favorite browser. If you prefer not to generate it manually, all files in this
directory are plain text and can be viewed using any text file reader.
The documentation is written in **ReStructuredText (ReST)** and uses the **Sphinx documentation system**.
## Generating the Documentation Locally
To generate the documentation, follow these steps:
1. **Install Sphinx**:
```sh
python -m pip install -r Docs/requirements.txt
```
2. **Navigate to the `Docs/` directory** in a terminal.
3. **Run the following command** to generate the HTML documentation:
```sh
make html
```
- On Windows, use:
```sh
make.bat html
```
Once the documentation is fully generated, you can open the **index.html** page located at:
```
_build/html/index.html
```
This will open the documentation in your browser for easy reading.
## Additional Resources
For more details on Unreal ML Agents, check out:
- [Unreal ML Agents Documentation (Online)](https://unrealmlagents.readthedocs.io/en/latest/)