.. image:: /_static/img/logo.png

`CompilerGym <https://github.com/facebookresearch/CompilerGym>`_ is a toolkit
for applying reinforcement learning to compiler optimizations.

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   getting_started
   about
   cli
   rpc
   changelog
   contributing
   faq

.. toctree::
   :maxdepth: 2
   :caption: Environments

   llvm/index
   envs/gcc
   envs/loop_tool

..
    .. toctree::
       :maxdepth: 1
       :caption: Tutorials
       tutorial/makefile_integration
       tutorial/reinforcement_learning
       tutorial/example_service

.. toctree::
   :maxdepth: 3
   :caption: Python API Reference

   compiler_gym/compiler_gym
   compiler_gym/datasets
   compiler_gym/envs
   compiler_gym/envs/gcc
   llvm/api
   compiler_gym/leaderboard
   compiler_gym/service
   compiler_gym/service/runtime
   compiler_gym/spaces
   compiler_gym/views
   compiler_gym/wrappers

.. toctree::
   :maxdepth: 3
   :caption: C++ API Reference

   cc/compiler_gym/envs/llvm/service
   cc/compiler_gym/service
   cc/compiler_gym/service/runtime
   cc/compiler_gym/util


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
