package tensorboard.data

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetExperiment (GetExperimentRequest, GetExperimentResponse)

  data_provider.proto:14

  Get metadata about an experiment.

  message GetExperimentRequest

  data_provider.proto:38

  • string experiment_id = 1

  message GetExperimentResponse

  data_provider.proto:42

  • string data_location = 1

    Human-readable description of the data source. This might be an absolute path on disk to a log directory of event files, a relative path, a URL to a cloud storage bucket, an address for a local socket server, etc. There does not need to be any way to "dereference" this address to read the original data directly.

  • string name = 2

    User-facing experiment name. This name is typically set by a user explicitly or automatically set by a training system.

  • string description = 3

    User-facing experiment description.

  • optional google.protobuf.Timestamp creation_time = 4

    Time that the experiment was created. This does not necessarily have any relation to times of events within an experiment. A new experiment may contain old data, or data may be freshly written to an experiment after it is created. May be unset if no creation time is known.

• rpc ListPlugins (ListPluginsRequest, ListPluginsResponse)

  data_provider.proto:16

  List plugins that have data for an experiment.

  message ListPluginsRequest

  data_provider.proto:101

  • string experiment_id = 1

    ID of experiment in which to query data.

  message ListPluginsResponse

  data_provider.proto:106

  • repeated Plugin plugins = 1

    List of active plugins: i.e., plugins that have data.

• rpc ListRuns (ListRunsRequest, ListRunsResponse)

  data_provider.proto:18

  List runs within an experiment.

  message ListRunsRequest

  data_provider.proto:117

  • string experiment_id = 1

    ID of experiment in which to query data.

  message ListRunsResponse

  data_provider.proto:122

  • repeated Run runs = 1

• rpc ListScalars (ListScalarsRequest, ListScalarsResponse)

  data_provider.proto:20

  List metadata about scalar time series.

  message ListScalarsRequest

  data_provider.proto:138

  • string experiment_id = 1

    ID of experiment in which to query data.

  • optional PluginFilter plugin_filter = 2

    Filter for the plugin that owns the scalars. It is an error if `plugin_filter.plugin_name` is the empty string.

  • optional RunTagFilter run_tag_filter = 3

    Optional filter for time series. If omitted, all time series match.

  message ListScalarsResponse

  data_provider.proto:148

  • repeated ListScalarsResponse.RunEntry runs = 1

• rpc ReadScalars (ReadScalarsRequest, ReadScalarsResponse)

  data_provider.proto:22

  Read data from scalar time series.

  message ReadScalarsRequest

  data_provider.proto:169

  • string experiment_id = 1

    ID of experiment in which to query data.

  • optional PluginFilter plugin_filter = 2

    Filter for the plugin that owns the scalars. It is an error if `plugin_filter.plugin_name` is the empty string.

  • optional RunTagFilter run_tag_filter = 3

    Optional filter for time series. If omitted, all time series match.

  • optional Downsample downsample = 4

    Required downsampling specification describing how many points to return per time series.

  message ReadScalarsResponse

  data_provider.proto:182

  • repeated ReadScalarsResponse.RunEntry runs = 1

• rpc ListTensors (ListTensorsRequest, ListTensorsResponse)

  data_provider.proto:24

  List metadata about tensor time series.

  message ListTensorsRequest

  data_provider.proto:205

  • string experiment_id = 1

    ID of experiment in which to query data.

  • optional PluginFilter plugin_filter = 2

    Filter for the plugin that owns the tensors. It is an error if `plugin_filter.plugin_name` is the empty string.

  • optional RunTagFilter run_tag_filter = 3

    Optional filter for time series. If omitted, all time series match.

  message ListTensorsResponse

  data_provider.proto:215

  • repeated ListTensorsResponse.RunEntry runs = 1

• rpc ReadTensors (ReadTensorsRequest, ReadTensorsResponse)

  data_provider.proto:26

  Read data from tensor time series.

  message ReadTensorsRequest

  data_provider.proto:236

  • string experiment_id = 1

    ID of experiment in which to query data.

  • optional PluginFilter plugin_filter = 2

    Filter for the plugin that owns the tensors. It is an error if `plugin_filter.plugin_name` is the empty string.

  • optional RunTagFilter run_tag_filter = 3

    Optional filter for time series. If omitted, all time series match.

  • optional Downsample downsample = 4

    Required downsampling specification describing how many points to return per time series.

  message ReadTensorsResponse

  data_provider.proto:249

  • repeated ReadTensorsResponse.RunEntry runs = 1

• rpc ListBlobSequences (ListBlobSequencesRequest, ListBlobSequencesResponse)

  data_provider.proto:28

  List metadata about blob sequence time series.

  message ListBlobSequencesRequest

  data_provider.proto:273

  • string experiment_id = 1

    ID of experiment in which to query data.

  • optional PluginFilter plugin_filter = 2

    Filter for the plugin that owns the blob sequences. It is an error if `plugin_filter.plugin_name` is the empty string.

  • optional RunTagFilter run_tag_filter = 3

    Optional filter for time series. If omitted, all time series match.

  message ListBlobSequencesResponse

  data_provider.proto:283

  • repeated ListBlobSequencesResponse.RunEntry runs = 1

• rpc ReadBlobSequences (ReadBlobSequencesRequest, ReadBlobSequencesResponse)

  data_provider.proto:32

  Read blob references from blob sequence time series. See `ReadBlob` to read the actual blob data.

  message ReadBlobSequencesRequest

  data_provider.proto:306

  • string experiment_id = 1

    ID of experiment in which to query data.

  • optional PluginFilter plugin_filter = 2

    Filter for the plugin that owns the blob sequences. It is an error if `plugin_filter.plugin_name` is the empty string.

  • optional RunTagFilter run_tag_filter = 3

    Optional filter for time series. If omitted, all time series match.

  • optional Downsample downsample = 4

    Required downsampling specification describing how many points to return per time series.

  message ReadBlobSequencesResponse

  data_provider.proto:319

  • repeated ReadBlobSequencesResponse.RunEntry runs = 1

• rpc ReadBlob (ReadBlobRequest, stream ReadBlobResponse)

  data_provider.proto:35

  Read data for a specific blob.

  message ReadBlobRequest

  data_provider.proto:358

  • string blob_key = 1

  message ReadBlobResponse

  data_provider.proto:362

  • bytes data = 1

    The bytes in this chunk. Should be concatenated with any other responses in the stream to recover the full blob contents.

A reference to a blob.

Used in: BlobReferenceSequence

• string blob_key = 1

  Unique identifier for a blob, which may be dereferenced via the `ReadBlob` RPC. Must be suitable for inclusion directly in a URL with no further encoding. Case-sensitive. Required; the empty string is not a valid key.

• string url = 2

  Optional URL from which the blob may be fetched directly, bypassing the data provider interface.

Used in: BlobSequenceData

• repeated BlobReference blob_refs = 1

A column-major sequence of blob sequence points. Arrays `step`, `wall_time`, and `value` have the same lengths. The `step` and `wall_time` fields are repeated primitive values, so they will be packed on the wire: <https://developers.google.com/protocol-buffers/docs/encoding#packed>

Used in: ReadBlobSequencesResponse.TagEntry

• repeated int64 step = 1

• repeated double wall_time = 2

• repeated BlobReferenceSequence values = 3

Used in: ListBlobSequencesResponse.TagEntry

• int64 max_step = 1

  Largest step value of any datum in this time series.

• double max_wall_time = 2

  Largest wall time of any datum in this time series.

• int64 max_length = 3

  Largest number of blobs in any datum in this time series.

• optional SummaryMetadata summary_metadata = 4

  Atemporal summary metadata for this time series.

Used in: ReadBlobSequencesRequest, ReadScalarsRequest, ReadTensorsRequest

• int64 num_points = 1

  Maximum number of points to return. Must be non-negative. Zero means zero.

Used in: ListBlobSequencesResponse

• string run_name = 1

• repeated TagEntry tags = 2

Used in: RunEntry

• string tag_name = 1

• optional BlobSequenceMetadata metadata = 2

Used in: ListScalarsResponse

• string run_name = 1

• repeated TagEntry tags = 2

Used in: RunEntry

• string tag_name = 1

• optional ScalarMetadata metadata = 2

Used in: ListTensorsResponse

• string run_name = 1

• repeated TagEntry tags = 2

Used in: RunEntry

• string tag_name = 1

• optional TensorMetadata metadata = 2

Used in: ListPluginsResponse

• string name = 1

  Plugin name, as listed in the `PluginData.plugin_name` field of a `SummaryMetadata` value.

Used in: ListBlobSequencesRequest, ListScalarsRequest, ListTensorsRequest, ReadBlobSequencesRequest, ReadScalarsRequest, ReadTensorsRequest

• string plugin_name = 1

  Only match data with exactly this plugin name.

Used in: ReadBlobSequencesResponse

• string run_name = 1

• repeated TagEntry tags = 2

Used in: RunEntry

• string tag_name = 1

• optional BlobSequenceData data = 2

Used in: ReadScalarsResponse

• string run_name = 1

• repeated TagEntry tags = 2

Used in: RunEntry

• string tag_name = 1

• optional ScalarData data = 2

Used in: ReadTensorsResponse

• string run_name = 1

• repeated TagEntry tags = 2

Used in: RunEntry

• string tag_name = 1

• optional TensorData data = 2

Used in: ListRunsResponse

• string name = 2

  User-facing name.

• double start_time = 3

  Wall time of earliest recorded event, as floating-point seconds since epoch (same as event file format).

Used in: RunTagFilter

• repeated string names = 1

  Only match runs with exactly one of these names. In particular, if this list is empty, no runs match.

Used in: ListBlobSequencesRequest, ListScalarsRequest, ListTensorsRequest, ReadBlobSequencesRequest, ReadScalarsRequest, ReadTensorsRequest

• optional RunFilter runs = 1

  Optional filter for runs. If omitted, *all* runs match; this is not equivalent to an empty submessage (which matches no tags).

• optional TagFilter tags = 2

  Optional filter for tags. If omitted, *all* tags match; this is not equivalent to an empty submessage (which matches no tags).

A column-major sequence of scalar points. Arrays `step`, `wall_time`, and `value` have the same lengths. These are repeated primitive values, so they will be packed on the wire: <https://developers.google.com/protocol-buffers/docs/encoding#packed>

Used in: ReadScalarsResponse.TagEntry

• repeated int64 step = 1

• repeated double wall_time = 2

• repeated float value = 3

Used in: ListScalarsResponse.TagEntry

• int64 max_step = 1

  Largest step value of any datum in this time series.

• double max_wall_time = 2

  Largest wall time of any datum in this time series.

• optional SummaryMetadata summary_metadata = 3

  Atemporal summary metadata for this time series.

Used in: RunTagFilter

• repeated string names = 1

  Only match tags with exactly one of these names. In particular, if this list is empty, no tags match.

A column-major sequence of tensor points. Arrays `step`, `wall_time`, and `value` have the same lengths. The `step` and `wall_time` fields are repeated primitive values, so they will be packed on the wire: <https://developers.google.com/protocol-buffers/docs/encoding#packed>

Used in: ReadTensorsResponse.TagEntry

• repeated int64 step = 1

• repeated double wall_time = 2

• repeated TensorProto value = 3

Used in: ListTensorsResponse.TagEntry

• int64 max_step = 1

  Largest step value of any datum in this time series.

• double max_wall_time = 2

  Largest wall time of any datum in this time series.

• optional SummaryMetadata summary_metadata = 3

  Atemporal summary metadata for this time series.