Skip to content

Commit

Permalink
[docs] Clarify documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisCummins committed May 24, 2022
1 parent 18ed285 commit 52671fb
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/source/compiler_gym/service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ compiler_gym.service

.. currentmodule:: compiler_gym.service

CompilerGym uses a client/server architecture. Services provide an interface for
manipulating compiler behavior. Clients are Python frontend objects that provide
a reinforcement learning abstraction on top of the service. Communication
between the service and client is done :doc:`using RPC </rpc>`. The connection between the
client and service is managed by the :class:`CompilerGymServiceConnection
The :code:`compiler_gym.service` module provides a client/service implementation
of the :class:`CompilerEnv <compiler_gym.envs.CompilerEnv>` interface. Services
provide an interface for manipulating compiler behavior. Clients are Python
frontend objects that provide a reinforcement learning abstraction on top of the
service. Communication between the service and client is done :doc:`using RPC
</rpc>`. The connection between the client and service is managed by the
:class:`CompilerGymServiceConnection
<compiler_gym.service.CompilerGymServiceConnection>` object.

.. contents:: Document contents:
Expand Down

0 comments on commit 52671fb

Please sign in to comment.