package compiler_gym

Get desktop application:
View/edit binary Protocol Buffers messages

The CompilerGymService is the interface that exposes the incremental optimization of a program as an interactive environment.

• rpc GetVersion (GetVersionRequest, GetVersionReply)

  compiler_gym_service.proto:24

  Request version strings from the service.

  message GetVersionRequest

  compiler_gym_service.proto:57

  A GetVersion() request.

  (message has no fields)

  message GetVersionReply

  compiler_gym_service.proto:60

  The GetVersion() response.

  • string service_version = 1

    The version string for this service.

  • string compiler_version = 2

    The version string for the underlying compiler.

• rpc GetSpaces (GetSpacesRequest, GetSpacesReply)

  compiler_gym_service.proto:28

  Request the action and observation spaces that this service supports. The service responds with an initial action space, and a list of available observation and reward spaces.

  message GetSpacesRequest

  compiler_gym_service.proto:422

  A GetSpaces() request.

  (message has no fields)

  message GetSpacesReply

  compiler_gym_service.proto:425

  A GetSpaces() reply.

  • repeated ActionSpace action_space_list = 1

    A list of one or more action spaces that the service supports.

  • repeated ObservationSpace observation_space_list = 2

    A list of available observation spaces. A service may support one or more observation spaces.

• rpc StartSession (StartSessionRequest, StartSessionReply)

  compiler_gym_service.proto:33

  Start a new CompilerGym service session. This allocates a new session on the service and returns a session ID. To terminate the session, call EndSession() once done. Raises grpc::StatusCode::NOT_FOUND if the requested benchmark URI is not found.

  message StartSessionRequest

  compiler_gym_service.proto:68

  A StartSession() request.

  • optional Benchmark benchmark = 4

    The benchmark to use.

  • int32 action_space = 2

    An index into the GetSpacesReply.action_space_list selecting the action space that is to be used for this session. Once set, the action space cannot be changed for the duration of the session.

  • repeated int32 observation_space = 3

    A list of indices into the GetSpacesReply.observation_space_list

  message StartSessionReply

  compiler_gym_service.proto:81

  A StartSession() reply.

  • int64 session_id = 1

    The ID that has been assigned to the session. The client must use this ID in all subsequent interactions with the service for this session.

  • optional ActionSpace new_action_space = 3

    A new action space. This is set only if, after initializing the session, the action space has changed from the default action space returned by GetSpaces(). If set, the environment should discard the previous action space and replace it with this one. Else, the action space remains unchanged.

  • repeated Event observation = 4

    Observed states after completing the action.

• rpc ForkSession (ForkSessionRequest, ForkSessionReply)

  compiler_gym_service.proto:37

  Fork a session. This creates a new session in exactly the same state. The new session must be terminated with EndSession() once done. This returns an error if the session to fork does not exist.

  message ForkSessionRequest

  compiler_gym_service.proto:398

  A Fork() request.

  • int64 session_id = 1

    The ID of the session to fork.

  message ForkSessionReply

  compiler_gym_service.proto:404

  A Fork() reply.

  • int64 session_id = 1

    The ID of the newly created session.

• rpc EndSession (EndSessionRequest, EndSessionReply)

  compiler_gym_service.proto:40

  End a CompilerGym service session. If the requested session does not exist, this returns an error.

  message EndSessionRequest

  compiler_gym_service.proto:410

  An EndSession() request.

  • int64 session_id = 1

    The ID of the session.

  message EndSessionReply

  compiler_gym_service.proto:416

  An EndSession() reply.

  • int32 remaining_sessions = 1

    The number of sessions that the service currently has.

• rpc Step (StepRequest, StepReply)

  compiler_gym_service.proto:46

  Apply a list of optimization decisions and compute a list of observations for a session. Optimization decisions are selected from the last ActionSpace returned by a call to GetSpaces() or Step(). Valid observations are queried using GetSpaces(). This returns an error if the requested session does not exist.

  message StepRequest

  compiler_gym_service.proto:97

  A Step() request.

  • int64 session_id = 1

    The ID of the session.

  • repeated Event action = 2

    A list of actions to execute, in order.

  • repeated int32 observation_space = 3

    A list of indices into the GetSpacesReply.observation_space_list

  message StepReply

  compiler_gym_service.proto:107

  A Step() reply.

  • bool end_of_session = 1

    Indicates that the session has ended. This could be because there are no further actions that can be made, or because the action has led to an invalid state. Once this field has been set, you should make no further calls to step(). However, you mays still request reward and new observations.

  • bool action_had_no_effect = 2

    A service may set this field to true if the action is known not to have any effect. This allows an agent to assume that observations or rewards computed before this action remain valid, providing that they are deterministic.

  • optional ActionSpace new_action_space = 3

    A new action space. This field is set if, as a result of running the requested action, the action space has changed. Else, the action space remains unchanged.

  • repeated Event observation = 4

    Observed states after completing the action.

• rpc AddBenchmark (AddBenchmarkRequest, AddBenchmarkReply)

  compiler_gym_service.proto:48

  Register a new benchmark.

  message AddBenchmarkRequest

  compiler_gym_service.proto:491

  An AddBenchmark() request.

  • repeated Benchmark benchmark = 1

    A list of benchmarks to add.

  message AddBenchmarkReply

  compiler_gym_service.proto:497

  An AddBenchmark() reply.

  (message has no fields)

• rpc SendSessionParameter (SendSessionParameterRequest, SendSessionParameterReply)

  compiler_gym_service.proto:53

  Transmit <key, value> parameters to a session. Each parameter generates a string response. It us up to the client/service to agree on a common schema for encoding and decoding these parameters. An unknown key/value returns grpc::StatusCode::INVALID_ARGUMENT.

  message SendSessionParameterRequest

  compiler_gym_service.proto:508

  A SendSessionParameter() request.

  • int64 session_id = 1

    The ID of the session.

  • repeated SessionParameter parameter = 2

    A list of <key, value> parameters to pass to the session.

  message SendSessionParameterReply

  compiler_gym_service.proto:516

  A SendSessionParameter() reply.

  • repeated string reply = 1

    A list of response messages, one per parameter request.

Used in: GetSpacesReply, StartSessionReply, StepReply

• string name = 1

• optional Space space = 2

Representation of the input to a compiler.

Used in: AddBenchmarkRequest, StartSessionRequest

• string uri = 1

  The name of the benchmark to add. In case of conflict with an existing benchmark, this new benchmark replaces the existing one.

• optional File program = 2

  The description of the program that is being compiled. It is up to the service to determine how to interpret this file, and it is the responsibility of the client to ensure that it provides the correct format. For example, the service could expect that this file contains serialized IR data, or an input source file.

• optional BenchmarkDynamicConfig dynamic_config = 3

  An optional configuration option that details how to build and run the benchmark program.

Description of how to build and run a benchmark binary.

Used in: Benchmark

• optional Command build_cmd = 1

  A command to execute to build the benchmark for dynamic execution.

• optional Command run_cmd = 2

  A command to execute to run the benchmark.

• repeated Command pre_run_cmd = 3

  A list of commands to execute before running the benchmark.

• repeated Command post_run_cmd = 4

  A list of commands to execute after running the benchmark.

Used in: Space

• optional BooleanTensor low = 1

• optional BooleanTensor high = 2

The [min, max] range of a boolean scalar.

Used in: BooleanSequenceSpace, Space

• oneof optional_min

  The minimum value (inclusive). If not set, the value is 0 (false).

  • bool min = 1

• oneof optional_max

  The maximum value (inclusive). If not set, the value is 1 (true).

  • bool max = 2

Used in: Space

• optional Int64Range length_range = 1

• optional BooleanRange scalar_range = 2

Used in: BooleanBox, Event

• repeated uint64 shape = 1

• repeated bool value = 2

  Flattened tensor of shape `shape` with C-like index order.

Used in: Space

• optional ByteTensor low = 1

• optional ByteTensor high = 2

Used in: Space

• optional Int64Range length_range = 1

• optional Int64Range scalar_range = 2

Used in: ByteBox, Event

• repeated uint64 shape = 1

• bytes value = 2

  Flattened tensor of shape `shape` with C-like index order.

Used in: Space

• optional Int64Range length_range = 1

  Number of byte arrays in the sequence.

Representation of a command that can be executed.

Used in: BenchmarkDynamicConfig

• repeated string argument = 1

  A list of command line arguments.

• map<string, string> env = 2

  An optional key-value mapping of environment variables to set.

• int32 timeout_seconds = 3

  The maximum runtime of the command.

• repeated string infile = 4

  An optional list of files that are required by this command. If set, the presence of the files will be tested for before running the command. This can be useful for providing informative error messages.

• repeated string outfile = 5

  An optional list of files that are generated by this command. If set, the presence of the files will be tested for after running the command.

• repeated string name = 1

Used in: Event

• map<string, Event> event = 1

Used in: Space

• map<string, Space> space = 1

A discrete space in :math:`{ 0, 1, \\dots, n-1 }`.

Used in: Space

• int64 n = 1

Used in: Space

• optional DoubleTensor low = 1

• optional DoubleTensor high = 2

The [min, max] range of an double scalar.

Used in: DoubleSequenceSpace, Space

• oneof optional_min

  The minimum value (inclusive). If not set, the value is -inf.

  • double min = 1

• oneof optional_max

  The maximum value (inclusive). If not set, the value is +inf.

  • double max = 2

Used in: Space

• optional Int64Range length_range = 1

• optional DoubleRange scalar_range = 2

Used in: DoubleBox, Event

• repeated uint64 shape = 1

• repeated double value = 2

  Flattened tensor of shape `shape` with C-like index order.

Common structure shared between actions and observations.

Used in: DictEvent, ListEvent, ObservationSpace, StartSessionReply, StepReply, StepRequest

• oneof optional_type_id

  • string type_id = 1

• oneof value

  • ListEvent event_list = 2

  • DictEvent event_dict = 3

  • bool boolean_value = 4

  • sint64 int64_value = 5

  • float float_value = 6

  • double double_value = 7

  • string string_value = 8

  • BooleanTensor boolean_tensor = 9

    Fixed and variable length sequences are represented as one-dimensional tensor.

  • ByteTensor byte_tensor = 10

  • Int64Tensor int64_tensor = 11

  • FloatTensor float_tensor = 12

  • DoubleTensor double_tensor = 13

  • StringTensor string_tensor = 14

  • google.protobuf.Any any_value = 15

A File message represents a file object.

Used in: Benchmark

• oneof data

  • bytes contents = 1

    The raw data of the file.

  • string uri = 2

    The URI of the file which can be accessed. Note that this requires that the compiler service and the Python frontend share a file system, which cannot be assumed for general use.

Used in: Space

• optional FloatTensor low = 1

• optional FloatTensor high = 2

The [min, max] range of an double scalar.

Used in: FloatSequenceSpace, Space

• oneof optional_min

  The minimum value (inclusive). If not set, the value is -inf.

  • float min = 1

• oneof optional_max

  The maximum value (inclusive). If not set, the value is +inf.

  • float max = 2

Used in: Space

• optional Int64Range length_range = 1

• optional FloatRange scalar_range = 2

Used in: Event, FloatBox

• repeated uint64 shape = 1

• repeated float value = 2

  Flattened tensor of shape `shape` with C-like index order.

Used in: Space

• optional Int64Tensor low = 1

• optional Int64Tensor high = 2

The [min, max] range of an int64 scalar.

Used in: BooleanSequenceSpace, ByteSequenceSpace, BytesSequenceSpace, DoubleSequenceSpace, FloatSequenceSpace, Int64SequenceSpace, Space, SpaceSequenceSpace, StringSequenceSpace, StringSpace

• oneof optional_min

  The minimum value (inclusive). If not set, the value is -2^63.

  • sint64 min = 1

• oneof optional_max

  The maximum value (inclusive). If not set, the value is 2^63 - 1.

  • sint64 max = 2

Used in: Space

• optional Int64Range length_range = 1

• optional Int64Range scalar_range = 2

Used in: Event, Int64Box

• repeated uint64 shape = 1

• repeated sint64 value = 2

  Flattened tensor of shape `shape` with C-like index order.

Used in: Event

• repeated Event event = 1

A list of spaces.

Used in: Space

• repeated Space space = 1

A discrete space in which every point in the space is named. This can be used for representing enumerations.

Used in: Space

• repeated string name = 1

  A list of names for every value in the space. The order in which these values are returned is used.

Used in: GetSpacesReply

• string name = 1

• optional Space space = 2

• bool deterministic = 3

  Whether the observation space is deterministic.

• bool platform_dependent = 4

  Whether the observations depend on the service execution environment.

• optional Event default_observation = 5

  A default observation. This value should be used by the client in lieu of a true observation if the compiler service terminates abruptly, such as a crash while applying an action.

Can be used in Space.any_value or Event.any_value to describe an opaque serialized data.

• string format = 1

• bytes data = 2

An arbitrary string parameter value for a session.

Used in: SendSessionParameterRequest

• string key = 1

  A string key.

• string value = 2

  A string value.

Used in: ActionSpace, DictSpace, ListSpace, ObservationSpace, SpaceSequenceSpace

• oneof optional_type_id

  • string type_id = 2

• oneof value

  • ListSpace space_list = 3

  • DictSpace space_dict = 4

  • DiscreteSpace discrete = 5

  • NamedDiscreteSpace named_discrete = 6

  • BooleanRange boolean_value = 7

  • Int64Range int64_value = 8

  • FloatRange float_value = 9

  • DoubleRange double_value = 10

  • StringSpace string_value = 11

  • BooleanSequenceSpace boolean_sequence = 12

  • ByteSequenceSpace byte_sequence = 13

  • BytesSequenceSpace bytes_sequence = 14

  • Int64SequenceSpace int64_sequence = 15

  • FloatSequenceSpace float_sequence = 16

  • DoubleSequenceSpace double_sequence = 17

  • StringSequenceSpace string_sequence = 18

  • SpaceSequenceSpace space_sequence = 25

  • BooleanBox boolean_box = 19

  • ByteBox byte_box = 20

  • Int64Box int64_box = 21

  • FloatBox float_box = 22

  • DoubleBox double_box = 23

  • google.protobuf.Any any_value = 24

  • ListSpace space_union = 26

A variable length sequence of spaces.

Used in: Space

• optional Int64Range length_range = 1

  The number of spaces in the sequence.

• optional Space space = 2

Used in: Space

• optional Int64Range length_range = 1

  The number of strings in the sequence.

Used in: Space

• optional Int64Range length_range = 1

Used in: Event

• repeated uint64 shape = 1

• repeated string value = 2

  Flattened tensor of shape `shape` with C-like index order.