mkdocs.yml

site_name: Unity ML-Agents Toolkit
site_url: https://unity-technologies.github.io/ml-agents/
repo_url: https://github.com/Unity-Technologies/ml-agents
edit_uri: edit/main/docs/
site_description: The Unity Machine Learning Agents Toolkit (ML-Agents) is an open-source project that enables games and simulations to serve as environments for training intelligent agents.
site_author: Unity Technologies
copyright: com.unity.ml-agents copyright © 2017 - 2022 Unity Technologies
nav:
- Home: index.md
- ML-Agents Overview: ML-Agents-Overview.md
- Installation: Installation.md
- Toolkit Documentation: ML-Agents-Toolkit-Documentation.md
- Background:
    - Machine Learning: Background-Machine-Learning.md
    - PyTorch: Background-PyTorch.md
    - Unity: Background-Unity.md
    - ELO: ELO-Rating-System.md
- Interfacing with Unity Builds:
    - Getting started with the Gym API: Python-Gym-API.md
    - Getting started with the PettingZoo API: Python-PettingZoo-API.md
    - Getting started with the LLAPI: Python-LLAPI.md
- Python API Docs:
    - Gym API Documentation: Python-Gym-API-Documentation.md
    - Petting Zoo Documentation: Python-PettingZoo-API-Documentation.md
    - LLAPI Documentation: Python-LLAPI-Documentation.md
    - On/Off Policy Trainer: Python-On-Off-Policy-Trainer-Documentation.md
- Tutorials:
    - Customizing Training via Plugins: Training-Plugins.md
    - Custom Trainer Plugin: Tutorial-Custom-Trainer-Plugin.md
    - HuggingFace: Hugging-Face-Integration.md
- About:
    - FAQs: FAQ.md
    - Limitations: Limitations.md
    - Migrating: Migrating.md
    - Versioning: Versioning.md
theme:
  name: material
  logo: images/unity-logo.png
  favicon: images/unity-logo-black.png
  palette:
    - primary: blue
    - accent: light blue
    # Palette toggle for light mode
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra_css:
  - extra.css
markdown_extensions:
    - markdown_include.include:
        base_path: docs
    - attr_list