package rlds_creator.client

Get desktop application:
View/edit binary Protocol Buffers messages

Request for sending the user actions.

Used in: OperationRequest

• repeated string keys = 1

  List of pressed keys.

• optional GamepadInput gamepad_input = 2

  Input from a gamepad controller.

Used in: OperationResponse

(message has no fields)

Request for adding a tag to the current episode being replayed.

Used in: OperationRequest

• optional string tag = 1

  Label of the tag to add.

Used in: OperationResponse

• optional string tag = 1

  Label of the tag specified in the corresponding request.

• optional bool success = 2

  True if the tag is added successfully.

Request for adding a tag to a step of the current episode being replayed.

Used in: OperationRequest

• optional int32 index = 1

  0-based index of the step.

• optional string tag = 2

  Label of the tag to add.

Used in: OperationResponse

• optional int32 index = 1

  0-based index of the step.

• optional string tag = 2

  Label of the tag specified in the corresponding request.

• optional bool success = 3

  True if the tag is added successfully.

Used in: OperationResponse

• optional string config = 1

  RLDS Creator configuration in JSON format. See config.py.

Asks user for confirmation to save the terminated episode.

Used in: OperationResponse

• optional bool mark_as_completed = 1

  Whether to mark the episode as completed or not. This will set the default value of the corresponding check box in the confirmation dialog.

An observation or action data.

Used in: ReplayStepResponse

• oneof type

  • string json_encoded = 2

    Arbitrary data in JSON format. This is usually a scalar or a Numpy array.

• repeated Data.Image images = 3

  List of images.

Used in: Data

• optional string name = 1

  Name of the image, e.g. that of the observation. It may be empty.

• optional bytes image = 2

  An image in JPEG or PNG format.

Request for deleting an episode.

Used in: OperationRequest

• optional EpisodeRef ref = 1

  Unique reference of the episode to delete.

Used in: OperationResponse

• optional EpisodeRef ref = 1

  Unique reference of the episode.

• optional bool success = 2

  Whether the episode is deleted or not.

Request for downloading a list of episodes. The episodes will be merged and stored in DM Environment Logger format.

Used in: OperationRequest

• repeated EpisodeRef refs = 1

  Unique references of the episodes.

• optional bool archive = 2

  If true, then the dataset, i.e. environment logger Riegeli files, will be stored as a single ZIP file. Otherwise, they will be stored under a directory.

• optional bool strip_internal_metadata = 3

  If true, then internal episode and step metadata, e.g. tags and notes for the episode and images and pressed keys for steps will be stripped. This will generate a more compact and Tensorflow friendly output (in particular, the number of pressed keys may change in each step and consequently the length of the tensor will not be fixed).

• repeated string end_of_episode_tags = 4

  List of step tags that denote the end of an episode.

Used in: OperationResponse

• optional string url = 1

  URL to download the (merged) episodes. This will be set when the progress is 100%.

• optional float progress = 2

  Percentage of progress (0-100).

Request to enable / disable a study.

Used in: OperationRequest

• optional string study_id = 1

  ID of the study.

• optional bool enable = 2

  Whether to enable or disable the study.

Used in: OperationResponse

• optional string study_id = 1

  ID of the study specified in the corresponding request.

• optional bool enabled = 2

  Whether the study is in enabled or disabled state.

Metadata about an episode. Next ID: 8

Used in: EpisodesResponse, ReplayEpisodeResponse, SaveEpisodeResponse

• optional StudySpec study = 1

  Specification of the study that the episode is part of.

• optional EnvironmentSpec env = 2

  Specification of the environment in the study that is used to generate the episode.

• optional Episode episode = 3

  Episode.

• optional string duration = 4

  Duration of the episode in human readable form, e.g. 30s.

• optional string video_url = 5

  URL for the video recording.

• optional string status = 6

  Status of the episode in human reaable form, e.g. Completed.

• optional bool can_delete = 7

  Whether the user can delete the episode or not.

Reference to uniquely identify an episode in a study and session.

Used in: DeleteEpisodeRequest, DeleteEpisodeResponse, DownloadEpisodesRequest, ReplayEpisodeRequest

• optional string study_id = 1

  ID of the study.

• optional string session_id = 2

  ID of the session.

• optional string episode_id = 3

  ID of the episode.

A list of episodes. This is usually the existing episodes recorded by the user for the current study.

Used in: OperationResponse

• repeated EpisodeMetadata episodes = 1

Used to indicate an error to the client.

Used in: OperationResponse

• optional string mesg = 1

  Error message.

Denotes the input from a gamepad controller. See https://www.w3.org/TR/gamepad/#gamepad-interface for more information.

Used in: ActionRequest

• optional string id = 3

  Identifies the brand and the style of the gamepad controller, e.g. Google LLC Stadia Controller rev. A (STANDARD GAMEPAD Vendor: 18d1 Product: 9400)

• map<int32, GamepadInput.Button> buttons = 1

  Buttons keyed by their indices.

• map<int32, float> axes = 2

  Values for the non-zeroaxes of the gamepad normalized in the range [-1.0, 1.0]. If the controller is perpendicular to the ground with the directional stick pointing up, -1.0 corresponds to "forward" or "left", and 1.0 corresponds to "backward" or "right".

Used in: GamepadInput

• optional bool pressed = 1

  The pressed state of the button.

• optional double value = 2

  For buttons that have an analog sensor, the amount which the button has been pressed in the range [0, 1]. 0 means full unpressed and 1.0 means fully pressed.

Encapsulates the requests that are sent from the client to the server. Next ID: 21

• oneof type

  • ActionRequest action = 1

  • AddEpisodeTagRequest add_episode_tag = 2

  • AddStepTagRequest add_step_tag = 19

  • DeleteEpisodeRequest delete_episode = 18

  • DownloadEpisodesRequest download_episodes = 4

  • EnableStudyRequest enable_study = 5

  • ReplayStepRequest replay_step = 6

  • RemoveEpisodeTagRequest remove_episode_tag = 7

  • RemoveStepTagRequest remove_step_tag = 20

  • ReplayEpisodeRequest replay_episode = 8

  • SaveEpisodeRequest save_episode = 9

  • SaveStudyRequest save_study = 10

  • SelectEnvironmentRequest select_environment = 11

  • SelectStudyRequest select_study = 12

  • SetCameraRequest set_camera = 17

  • SetFpsRequest set_fps = 13

  • SetQualityRequest set_quality = 16

  • SetStudiesRequest set_studies = 14

  • UpdateReplayEpisodeRequest update_replay_episode = 15

Encapsulates the responses that are sent from the server to the client. Next ID: 26

• oneof type

  • ActionResponse action = 1

  • AddEpisodeTagResponse add_episode_tag = 2

  • AddStepTagResponse add_step_tag = 24

  • ConfigResponse config = 3

  • ConfirmSaveResponse confirm_save = 18

  • DeleteEpisodeResponse delete_episode = 23

  • DownloadEpisodesResponse download_episodes = 4

  • EnableStudyResponse enable_study = 5

  • EpisodesResponse episodes = 20

  • ErrorResponse error = 21

  • ReplayStepResponse replay_step = 7

  • PauseResponse pause = 17

  • RemoveEpisodeTagResponse remove_episode_tag = 8

  • RemoveStepTagResponse remove_step_tag = 25

  • ReplayEpisodeResponse replay_episode = 9

  • SaveEpisodeResponse save_episode = 10

  • SaveStudyResponse save_study = 11

  • SelectEnvironmentResponse select_environment = 12

  • SelectStudyResponse select_study = 13

  • SetCameraResponse set_camera = 22

  • SetFpsResponse set_fps = 14

  • SetStudiesResponse set_studies = 15

  • StepResponse step = 19

  • UpdateReplayEpisodeResponse update_replay_episode = 16

Used to indicate whether the episode being recorded is paused or not.

Used in: OperationResponse

• optional bool paused = 1

Request for removing a tag from the current episode being replayed.

Used in: OperationRequest

• optional string tag = 1

  Label of the tag to remove.

Used in: OperationResponse

• optional string tag = 1

  Label of the tag specified in the corresponding request.

• optional bool success = 2

  True if the tag is removed successfully.

Request for removing a tag from a step of the current episode being replayed.

Used in: OperationRequest

• optional int32 index = 1

  0-based index of the step.

• optional string tag = 2

  Label of the tag to remove.

Used in: OperationResponse

• optional int32 index = 1

  0-based index of the step.

• optional string tag = 2

  Label of the tag specified in the corresponding request.

• optional bool success = 3

  True if the tag is removed successfully.

Request to replay an episode.

Used in: OperationRequest

• optional EpisodeRef ref = 1

  Unique reference of the episode to replay.

Used in: OperationResponse

• optional EpisodeMetadata episode = 1

  Metadata of the episode that starts to be replayed.

• repeated float step_rewards = 2

  Rewards at each step of the episode. None values will be replaced by 0.

Request to replay a particular step of an episode.

Used in: OperationRequest

• optional int32 index = 1

  0-based index of the step to replay.

Used in: OperationResponse

• optional int32 index = 1

  0-based index of the step being replayed.

• optional bytes image = 2

  Visual rendering of the step.

• repeated string keys = 3

  Keys pressed by the user.

• optional float reward = 4

  Environment reward, observation and action.

• optional Data observation = 5

• optional Data action = 6

• repeated string tags = 7

  Tags of the step.

Request to accept or reject to save the terminated episode.

Used in: OperationRequest

• optional bool accept = 1

  Whether to accept or reject.

• optional bool mark_as_completed = 2

  Whether to mark the episode as completed or not. If false, then the episode will be in cancelled state.

Metadata of the saved episode.

Used in: OperationResponse

• optional EpisodeMetadata episode = 1

Request to save a study.

Used in: OperationRequest

• optional StudySpec study = 1

  Specification of the study to save. If the study_id field is set, then the existing study with the specified ID will be updated. Otherwise, a new study will be created. When updating an existing study, the readonly fields (e.g. its creator, creation time and state) will be ignored if set in the request.

Used in: OperationResponse

(message has no fields)

Request to select an environment from the current study.

Used in: OperationRequest

• optional string env_id = 1

  ID of the environment in the study.

Used in: OperationResponse

• optional string study_id = 1

  ID of the current study.

• optional EnvironmentSpec env = 2

  Specification of the selected environment.

Request to select a study.

Used in: OperationRequest

• optional string study_id = 1

  ID of the study.

Used in: OperationResponse

• optional StudySpec study = 1

  Specification of the selected study.

Request to set the camera.

Used in: OperationRequest

• optional int32 index = 1

  0-based index of the camera to use for rendering images.

Used in: OperationResponse

• optional int32 index = 1

  0-based index of the current camera.

• optional string name = 2

  Name of the camera; this may be empty.

Request to change the speed (frames/sec) of the current environment. Only applies to asynchronous environments.

Used in: OperationRequest

• optional float fps = 1

Used in: OperationResponse

(message has no fields)

Request to change the rendering quality. The resolution of the images will be the same, but the visual aspects and size will differ.

Used in: OperationRequest

• optional SetQualityRequest.Quality quality = 1

Used in: SetQualityRequest

• QUALITY_UNSPECIFIED = 0

• QUALITY_LOW = 1

  Low, medium and high correspond to web_{low, medium, high} JPEG quality settings in Pillow. Please see https://pillow.readthedocs.io/en/stable/reference/JpegPresets.html for more information. QUALITY_LOW encodes images faster with smaller size, but there may be visible defects.

• QUALITY_MEDIUM = 2

• QUALITY_HIGH = 3

Request to get the studies.

Used in: OperationRequest

(message has no fields)

A list of studies. This is usually the studies created by the user.

Used in: OperationResponse

• repeated StudySpec studies = 1

Information about the current step of the episode being recorded.

Used in: OperationResponse

• optional bytes image = 1

  Visual rendering of the step.

• optional int32 episode_index = 2

  0-based index of the episode in the current session.

• optional int32 episode_steps = 3

  Number of steps in the episode (so far).

• optional float reward = 4

  Environment reward.

Request to update the metadata of the episode being replayed.

Used in: OperationRequest

• optional string notes = 1

  User notes.

Used in: OperationResponse

• optional bool success = 1

  Whether the update is successful or not.