Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 2.5 KB

README.md

File metadata and controls

68 lines (50 loc) · 2.5 KB

Example CompilerGym Service

CompilerGym uses a client/service architecture. The client is the frontend python API and the service is the backend that handles the actual compilation. The backend exposes a CompilerGymService RPC interface that the frontend interacts with.

This directory contains an example backend service implemented in C++ and Python. Both implementations have the same features. They don't do any actual compilation, but can be used as a starting point for adding support for new compilers, or for debugging and testing frontend code.

If you have any questions please file an issue.

Features

  • A static action space with three items: ["a", "b", "c"]. The action space never changes. Actions never end the episode.
  • There are two observation spaces:
    • ir which returns the string "Hello, world!".
    • features which returns an int64_tensor of [0, 0, 0].
  • A single reward space runtime which returns 0.
  • It has a single dataset "benchmark://example-compiler-v0" with two programs "foo" and "bar".

Implementation

There are two identical service implementations, one in Python, one in C++. See service_cc/ExampleService.h for the C++ service, and service_py/example_service.py for the Python service. The module init.py defines the reward space, dataset, and registers two new environments using these services.

The file demo.py demonstrates how to use these example environments using CompilerGym's bazel build system. The file env_tests.py contains unit tests for the example services. Because the Python and C++ services implement the same interface, the same tests are run against both environments.

Usage

Run the demo script using:

$ bazel run -c opt //examples/example_compiler_gym_service:demo

Run the unit tests using:

$ bazel test //examples/example_compiler_gym_service/...

Using the python service without bazel

Because the python service contains no compiled code, it can be run directly as a standalone script without using the bazel build system. From the root of the CompilerGym repository, run:

$ cd examples
$ python3 example_compiler_gym_service/demo_without_bazel.py