package tensorboard

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: NodeExecStats, TensorDescription

• int64 requested_bytes = 1

  Total number of bytes requested

• int64 allocated_bytes = 2

  Total number of bytes allocated if known

• string allocator_name = 3

  Name of the allocator used

• int64 allocation_id = 4

  Identifier of the allocated buffer if known

• bool has_single_reference = 5

  Set if this tensor only has one remaining reference

• uint64 ptr = 6

  Address of the allocation.

An allocation/de-allocation operation performed by the allocator.

Used in: AllocatorMemoryUsed, ExecProfile

• int64 alloc_micros = 1

  The timestamp of the operation.

• int64 alloc_bytes = 2

  Number of bytes allocated, or de-allocated if negative.

Used in: NodeExecStats

• string allocator_name = 1

• int64 total_bytes = 2

  These are per-node allocator memory stats.

• int64 peak_bytes = 3

• int64 live_bytes = 4

  The bytes that are not deallocated.

• repeated AllocationRecord allocation_records = 6

  The allocation and deallocation timeline.

• int64 allocator_bytes_in_use = 5

  These are snapshots of the overall allocator memory stats. The number of live bytes currently allocated by the allocator.

Used to specify and override the default API & behavior in the generated code for client languages, from what you would get from the OpDef alone. There will be a set of ApiDefs that are common to all client languages, and another set per client language. The per-client-language ApiDefs will inherit values from the common ApiDefs which it can either replace or modify. We separate the API definition from the OpDef so we can evolve the API while remaining backwards compatible when interpretting old graphs. Overrides go in an "api_def.pbtxt" file with a text-format ApiDefs message. WARNING: Be *very* careful changing the API for any existing op -- you can change the semantics of existing code. These changes may need to wait until a major release of TensorFlow to avoid breaking our compatibility promises.

Used in: ApiDefs

• string graph_op_name = 1

  Name of the op (in the OpDef) to specify the API for.

• string deprecation_message = 12

  If this op is deprecated, set deprecation message to the message that should be logged when this op is used. The message should indicate alternative op to use, if any.

• int32 deprecation_version = 13

  Major version when the op will be deleted. For e.g. set this value to 2 if op API should be removed in TensorFlow 2.0 and deprecated in versions before that.

• ApiDef.Visibility visibility = 2

• repeated ApiDef.Endpoint endpoint = 3

• repeated ApiDef.Arg in_arg = 4

• repeated ApiDef.Arg out_arg = 5

• repeated string arg_order = 11

  List of original in_arg names to specify new argument order. Length of arg_order should be either empty to keep current order or match size of in_arg.

• repeated ApiDef.Attr attr = 6

• string summary = 7

  One-line human-readable description of what the Op does.

• string description = 8

  Additional, longer human-readable description of what the Op does.

• string description_prefix = 9

  Modify an existing/inherited description by adding text to the beginning or end.

• string description_suffix = 10

Used in: ApiDef

• string name = 1

• string rename_to = 2

  Change the name used to access this arg in the API from what is used in the GraphDef. Note that these names in `backticks` will also be replaced in the summary & description fields.

• string description = 3

  Note: this will replace any inherited arg doc. There is no current way of modifying arg descriptions (other than replacing them entirely) as can be done with op descriptions.

Description of the graph-construction-time configuration of this Op. That is to say, this describes the attr fields that will be specified in the NodeDef.

Used in: ApiDef

• string name = 1

• string rename_to = 2

  Change the name used to access this attr in the API from what is used in the GraphDef. Note that these names in `backticks` will also be replaced in the summary & description fields.

• optional AttrValue default_value = 3

  Specify a new default value to use for this attr. This default will be used when creating new graphs, as opposed to the default in the OpDef, which will be used when interpreting old GraphDefs.

• string description = 4

  Note: this will replace any inherited attr doc, there is no current way of modifying attr descriptions as can be done with op descriptions.

If you specify any endpoint, this will replace all of the inherited endpoints. The first endpoint should be the "canonical" endpoint, and should not be deprecated (unless all endpoints are deprecated).

Used in: ApiDef

• string name = 1

  Name should be either like "CamelCaseName" or "Package.CamelCaseName". Client-language-specific ApiDefs may use a snake_case convention instead of CamelCase.

• bool deprecated = 3

  Set if this endpoint is deprecated. If set to true, a message suggesting to use a non-deprecated endpoint instead will be printed. If all endpoints are deprecated, set deprecation_message in ApiDef instead.

• int32 deprecation_version = 4

  Major version when an endpoint will be deleted. For e.g. set this value to 2 if endpoint should be removed in TensorFlow 2.0 and deprecated in versions before that.

Used in: ApiDef

• DEFAULT_VISIBILITY = 0

  Normally this is "VISIBLE" unless you are inheriting a different value from another ApiDef.

• VISIBLE = 1

  Publicly visible in the API.

• SKIP = 2

  Do not include this op in the generated API. If visibility is set to 'SKIP', other fields are ignored for this op.

• HIDDEN = 3

  Hide this op by putting it into an internal namespace (or whatever is appropriate in the target language).

• repeated ApiDef op = 1

An asset file def for a single file or a set of sharded files with the same name.

Used in: MetaGraphDef

• optional TensorInfo tensor_info = 1

  The tensor to bind the asset filename to.

• string filename = 2

  The filename within an assets directory. Note: does not include the path prefix, i.e. directories. For an asset at /tmp/path/vocab.txt, the filename would be "vocab.txt".

Protocol buffer representing the value for an attr used to configure an Op. Comment indicates the corresponding attr type. Only the field matching the attr type may be filled.

Used in: ApiDef.Attr, FunctionDef, FunctionDef.ArgAttrs, NameAttrList, NodeDef, OpDef.AttrDef, ProfileNode, RewriterConfig.CustomGraphOptimizer

• oneof value

  • bytes s = 2

    "string"

  • int64 i = 3

    "int"

  • float f = 4

    "float"

  • bool b = 5

    "bool"

  • DataType type = 6

    "type"

  • TensorShapeProto shape = 7

    "shape"

  • TensorProto tensor = 8

    "tensor"

  • AttrValue.ListValue list = 1

    any "list(...)"

  • NameAttrList func = 10

    "func" represents a function. func.name is a function's name or a primitive op's name. func.attr.first is the name of an attr defined for that function. func.attr.second is the value for that attr in the instantiation.

  • string placeholder = 9

    This is a placeholder only used in nodes defined inside a function. It indicates the attr value will be supplied when the function is instantiated. For example, let us suppose a node "N" in function "FN". "N" has an attr "A" with value placeholder = "foo". When FN is instantiated with attr "foo" set to "bar", the instantiated node N's attr A will have been given the value "bar".

LINT.IfChange

Used in: AttrValue

• repeated bytes s = 2

  "list(string)"

• repeated int64 i = 3

  "list(int)"

• repeated float f = 4

  "list(float)"

• repeated bool b = 5

  "list(bool)"

• repeated DataType type = 6

  "list(type)"

• repeated TensorShapeProto shape = 7

  "list(shape)"

• repeated TensorProto tensor = 8

  "list(tensor)"

• repeated NameAttrList func = 9

  "list(attr)"

Audio summaries created by the `tensorboard.plugins.audio.summary` module will include `SummaryMetadata` whose `plugin_data` field has as `content` a binary string that is the encoding of an `AudioPluginData` proto.

• int32 version = 1

  Version `0` is the only supported version. It has the following semantics: - If the tensor shape is rank-2, then `t[:, 0]` represent encoded audio data, and `t[:, 1]` represent corresponding UTF-8 encoded Markdown labels. - If the tensor shape is rank-1, then `t[:]` represent encoded audio data. There are no labels.

• AudioPluginData.Encoding encoding = 2

Used in: AudioPluginData

• UNKNOWN = 0

  Do not use `UNKNOWN`; it is only present because it must be.

• WAV = 11

Used in: RewriterConfig

• bool enable = 1

• int32 num_replicas = 2

A protobuf to represent tf.BoundedTensorSpec.

Used in: StructuredValue

• string name = 1

• optional TensorShapeProto shape = 2

• DataType dtype = 3

• optional TensorProto minimum = 4

• optional TensorProto maximum = 5

Defines a subgraph in another `GraphDef` as a set of feed points and nodes to be fetched or executed. Compare with the arguments to `Session::Run()`.

• repeated string feed = 1

  Tensors to be fed in the callable. Each feed is the name of a tensor.

• repeated string fetch = 2

  Fetches. A list of tensor names. The caller of the callable expects a tensor to be returned for each fetch[i] (see RunStepResponse.tensor). The order of specified fetches does not change the execution order.

• repeated string target = 3

  Target Nodes. A list of node names. The named nodes will be run by the callable but their outputs will not be returned.

• optional RunOptions run_options = 4

  Options that will be applied to each run.

• repeated TensorConnection tensor_connection = 5

  Tensors to be connected in the callable. Each TensorConnection denotes a pair of tensors in the graph, between which an edge will be created in the callable.

• map<string, string> feed_devices = 6

  The Tensor objects fed in the callable and fetched from the callable are expected to be backed by host (CPU) memory by default. The options below allow changing that - feeding tensors backed by device memory, or returning tensors that are backed by device memory. The maps below map the name of a feed/fetch tensor (which appears in 'feed' or 'fetch' fields above), to the fully qualified name of the device owning the memory backing the contents of the tensor. For example, creating a callable with the following options: CallableOptions { feed: "a:0" feed: "b:0" fetch: "x:0" fetch: "y:0" feed_devices: { "a:0": "/job:localhost/replica:0/task:0/device:GPU:0" } fetch_devices: { "y:0": "/job:localhost/replica:0/task:0/device:GPU:0" } } means that the Callable expects: - The first argument ("a:0") is a Tensor backed by GPU memory. - The second argument ("b:0") is a Tensor backed by host memory. and of its return values: - The first output ("x:0") will be backed by host memory. - The second output ("y:0") will be backed by GPU memory. FEEDS: It is the responsibility of the caller to ensure that the memory of the fed tensors will be correctly initialized and synchronized before it is accessed by operations executed during the call to Session::RunCallable(). This is typically ensured by using the TensorFlow memory allocators (Device::GetAllocator()) to create the Tensor to be fed. Alternatively, for CUDA-enabled GPU devices, this typically means that the operation that produced the contents of the tensor has completed, i.e., the CUDA stream has been synchronized (e.g., via cuCtxSynchronize() or cuStreamSynchronize()).

• map<string, string> fetch_devices = 7

• bool fetch_skip_sync = 8

  By default, RunCallable() will synchronize the GPU stream before returning fetched tensors on a GPU device, to ensure that the values in those tensors have been produced. This simplifies interacting with the tensors, but potentially incurs a performance hit. If this options is set to true, the caller is responsible for ensuring that the values in the fetched tensors have been produced before they are used. The caller can do this by invoking `Device::Sync()` on the underlying device(s), or by feeding the tensors back to the same Session using `feed_devices` with the same corresponding device name.

* A category contains a group of charts. Each category maps to a collapsible within the dashboard.

Used in: Layout

• string title = 1

  This string appears atop each grouping of charts within the dashboard.

• repeated Chart chart = 2

  Encapsulates data on charts to be shown in the category.

• bool closed = 3

  Whether this category should be initially closed. False by default.

* Encapsulates information on a single chart. Many charts appear in a category.

Used in: Category

• string title = 1

  The title shown atop this chart. Optional. Defaults to 'untitled'.

• oneof content

  The content of the chart. This depends on the type of the chart.

  • MultilineChartContent multiline = 2

  • MarginChartContent margin = 3

Defines a TensorFlow cluster as a set of jobs.

Used in: ConfigProto

• repeated JobDef job = 1

  The jobs that comprise the cluster.

It specifies the Python callstack that creates an op.

Used in: OpLogEntry, ProfileNode

• repeated CodeDef.Trace traces = 1

Used in: CodeDef

• string file = 1

  deprecated by file_id.

• int64 file_id = 6

• int32 lineno = 2

• string function = 3

  deprecated by function_id.

• int64 function_id = 7

• string line = 4

  deprecated line_id.

• int64 line_id = 8

• int32 func_start_line = 5

CollectionDef should cover most collections. To add a user-defined collection, do one of the following: 1. For simple data types, such as string, int, float: tf.add_to_collection("your_collection_name", your_simple_value) strings will be stored as bytes_list. 2. For Protobuf types, there are three ways to add them: 1) tf.add_to_collection("your_collection_name", your_proto.SerializeToString()) collection_def { key: "user_defined_bytes_collection" value { bytes_list { value: "queue_name: \"test_queue\"\n" } } } or 2) tf.add_to_collection("your_collection_name", str(your_proto)) collection_def { key: "user_defined_string_collection" value { bytes_list { value: "\n\ntest_queue" } } } or 3) any_buf = any_pb2.Any() tf.add_to_collection("your_collection_name", any_buf.Pack(your_proto)) collection_def { key: "user_defined_any_collection" value { any_list { value { type_url: "type.googleapis.com/tensorflow.QueueRunnerDef" value: "\n\ntest_queue" } } } } 3. For Python objects, implement to_proto() and from_proto(), and register them in the following manner: ops.register_proto_function("your_collection_name", proto_type, to_proto=YourPythonObject.to_proto, from_proto=YourPythonObject.from_proto) These functions will be invoked to serialize and de-serialize the collection. For example, ops.register_proto_function(ops.GraphKeys.GLOBAL_VARIABLES, proto_type=variable_pb2.VariableDef, to_proto=Variable.to_proto, from_proto=Variable.from_proto)

Used in: MetaGraphDef

• oneof kind

  • CollectionDef.NodeList node_list = 1

  • CollectionDef.BytesList bytes_list = 2

  • CollectionDef.Int64List int64_list = 3

  • CollectionDef.FloatList float_list = 4

  • CollectionDef.AnyList any_list = 5

AnyList is used for collecting Any protos.

Used in: CollectionDef

• repeated google.protobuf.Any value = 1

BytesList is used for collecting strings and serialized protobufs. For example: collection_def { key: "trainable_variables" value { bytes_list { value: "\n\017conv1/weights:0\022\024conv1/weights/Assign \032\024conv1/weights/read:0" value: "\n\016conv1/biases:0\022\023conv1/biases/Assign\032 \023conv1/biases/read:0" } } }

Used in: CollectionDef

• repeated bytes value = 1

FloatList is used for collecting float values.

Used in: CollectionDef

• repeated float value = 1

Int64List is used for collecting int, int64 and long values.

Used in: CollectionDef

• repeated int64 value = 1

NodeList is used for collecting nodes in graph. For example collection_def { key: "summaries" value { node_list { value: "input_producer/ScalarSummary:0" value: "shuffle_batch/ScalarSummary:0" value: "ImageSummary:0" } }

Used in: CollectionDef

• repeated string value = 1

Session configuration parameters. The system picks appropriate values for fields that are not set.

• map<string, int32> device_count = 1

  Map from device type name (e.g., "CPU" or "GPU" ) to maximum number of devices of that type to use. If a particular device type is not found in the map, the system picks an appropriate number.

• int32 intra_op_parallelism_threads = 2

  The execution of an individual op (for some op types) can be parallelized on a pool of intra_op_parallelism_threads. 0 means the system picks an appropriate number. If you create an ordinary session, e.g., from Python or C++, then there is exactly one intra op thread pool per process. The first session created determines the number of threads in this pool. All subsequent sessions reuse/share this one global pool. There are notable exceptions to the default behavior describe above: 1. There is an environment variable for overriding this thread pool, named TF_OVERRIDE_GLOBAL_THREADPOOL. 2. When connecting to a server, such as a remote `tf.train.Server` instance, then this option will be ignored altogether.

• int32 inter_op_parallelism_threads = 5

  Nodes that perform blocking operations are enqueued on a pool of inter_op_parallelism_threads available in each process. 0 means the system picks an appropriate number. Negative means all operations are performed in caller's thread. Note that the first Session created in the process sets the number of threads for all future sessions unless use_per_session_threads is true or session_inter_op_thread_pool is configured.

• bool use_per_session_threads = 9

  If true, use a new set of threads for this session rather than the global pool of threads. Only supported by direct sessions. If false, use the global threads created by the first session, or the per-session thread pools configured by session_inter_op_thread_pool. This option is deprecated. The same effect can be achieved by setting session_inter_op_thread_pool to have one element, whose num_threads equals inter_op_parallelism_threads.

• repeated ThreadPoolOptionProto session_inter_op_thread_pool = 12

  This option is experimental - it may be replaced with a different mechanism in the future. Configures session thread pools. If this is configured, then RunOptions for a Run call can select the thread pool to use. The intended use is for when some session invocations need to run in a background pool limited to a small number of threads: - For example, a session may be configured to have one large pool (for regular compute) and one small pool (for periodic, low priority work); using the small pool is currently the mechanism for limiting the inter-op parallelism of the low priority work. Note that it does not limit the parallelism of work spawned by a single op kernel implementation. - Using this setting is normally not needed in training, but may help some serving use cases. - It is also generally recommended to set the global_name field of this proto, to avoid creating multiple large pools. It is typically better to run the non-low-priority work, even across sessions, in a single large pool.

• int32 placement_period = 3

  Assignment of Nodes to Devices is recomputed every placement_period steps until the system warms up (at which point the recomputation typically slows down automatically).

• repeated string device_filters = 4

  When any filters are present sessions will ignore all devices which do not match the filters. Each filter can be partially specified, e.g. "/job:ps" "/job:worker/replica:3", etc.

• optional GPUOptions gpu_options = 6

  Options that apply to all GPUs.

• bool allow_soft_placement = 7

  Whether soft placement is allowed. If allow_soft_placement is true, an op will be placed on CPU if 1. there's no GPU implementation for the OP or 2. no GPU devices are known or registered or 3. need to co-locate with reftype input(s) which are from CPU.

• bool log_device_placement = 8

  Whether device placements should be logged.

• optional GraphOptions graph_options = 10

  Options that apply to all graphs.

• int64 operation_timeout_in_ms = 11

  Global timeout for all blocking operations in this session. If non-zero, and not overridden on a per-operation basis, this value will be used as the deadline for all blocking operations.

• optional RPCOptions rpc_options = 13

  Options that apply when this session uses the distributed runtime.

• optional ClusterDef cluster_def = 14

  Optional list of all workers to use in this session.

• bool isolate_session_state = 15

  If true, any resources such as Variables used in the session will not be shared with other sessions. However, when clusterspec propagation is enabled, this field is ignored and sessions are always isolated.

• bool share_cluster_devices_in_session = 17

  When true, WorkerSessions are created with device attributes from the full cluster. This is helpful when a worker wants to partition a graph (for example during a PartitionedCallOp).

• optional ConfigProto.Experimental experimental = 16

Everything inside Experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.

Used in: ConfigProto

• string collective_group_leader = 1

  Task name for group resolution.

• string executor_type = 3

  Which executor to use, the default executor will be used if it is an empty string or "DEFAULT"

• int32 recv_buf_max_chunk = 4

  Guidance to formatting of large RecvBuf fields for transfer. Any positive value sets the max chunk size. 0 defaults to 4096. Any negative value indicates no max, i.e. one chunk only.

• bool use_numa_affinity = 5

  If true, and supported by the platform, the runtime will attempt to use NUMA affinity where applicable. One consequence will be the existence of as many CPU devices as there are available NUMA nodes.

• bool collective_deterministic_sequential_execution = 6

  If true, make collective op execution order sequential and deterministic for potentially concurrent collective instances.

• bool collective_nccl = 7

  If true, use NCCL for CollectiveOps. This feature is highly experimental.

• bool share_session_state_in_clusterspec_propagation = 8

  In the following, session state means the value of a variable, elements in a hash table, or any other resource, accessible by worker sessions held by a TF server. When ClusterSpec propagation is enabled, the value of isolate_session_state is ignored when deciding whether to share session states in a TF server (for backwards compatibility reasons). - If share_session_state_in_clusterspec_propagation is true, the session states are shared. - If share_session_state_in_clusterspec_propagation is false, session states are isolated. When clusterspec propagation is not used, the value of share_session_state_in_clusterspec_propagation is ignored when deciding whether to share session states in a TF server. - If isolate_session_state is true, session states are isolated. - If isolate_session_state is false, session states are shared. TODO(b/129330037): Add a single API that consistently treats isolate_session_state and ClusterSpec propagation.

• bool disable_thread_spinning = 9

  If using a direct session, disable spinning while waiting for work in the thread pool. This may result in higher latency for completing ops, but in the case where there is a lot of spinning may result in lower CPU usage.

• bool share_cluster_devices_in_session = 10

  This was promoted to a non-experimental API. Please use ConfigProto.share_cluster_devices_in_session instead.

• optional SessionMetadata session_metadata = 11

  Metadata about the session. If set, this can be used by the runtime and the Ops for debugging, monitoring, etc. NOTE: This is currently used and propagated only by the direct session.

• bool optimize_for_static_graph = 12

  If true, the session may treat the graph as being static for optimization purposes. If this option is set to true when a session is created, the full GraphDef must be passed in a single call to Session::Create(), and Session::Extend() may not be supported.

• bool enable_mlir_bridge = 13

  Whether to enable the MLIR-based TF->XLA bridge. This is a replacement to the existing bridge, and not ready for production usage yet. If this option is set to true when a session is created, MLIR is used to perform the set of graph transformations to put the graph in a form that can be executed with delegation of some computations to an accelerator. This builds on the model of XLA where a subset of the graph is encapsulated and attached to a "compile" operation, whose result is fed to an "execute" operation. The kernel for these operations is responsible to lower the encapsulated graph to a particular device.

• bool enable_mlir_graph_optimization = 16

  Whether to enable the MLIR-based Graph optimizations. This will become a part of standard Tensorflow graph optimization pipeline, currently this is only used for gradual migration and testing new passes that are replacing existing optimizations in Grappler.

• bool disable_output_partition_graphs = 14

  If true, the session will not store an additional copy of the graph for each subgraph. If this option is set to true when a session is created, the `RunOptions.output_partition_graphs` options must not be set.

• int64 xla_fusion_autotuner_thresh = 15

  Minimum number of batches run through the XLA graph before XLA fusion autotuner is enabled. Default value of zero disables the autotuner. The XLA fusion autotuner can improve performance by executing a heuristic search on the compiler parameters.

Used in: RunMetadata

• repeated CostGraphDef.Node node = 1

• repeated CostGraphDef.AggregatedCost cost = 2

Total cost of this graph, typically used for balancing decisions.

Used in: CostGraphDef

• float cost = 1

  Aggregated cost value.

• string dimension = 2

  Aggregated cost dimension (e.g. 'memory', 'compute', 'network').

Used in: CostGraphDef

• string name = 1

  The name of the node. Names are globally unique.

• string device = 2

  The device of the node. Can be empty if the node is mapped to the default partition or partitioning hasn't been run yet.

• int32 id = 3

  The id of the node. Node ids are only unique inside a partition.

• repeated Node.InputInfo input_info = 4

• repeated Node.OutputInfo output_info = 5

• int64 temporary_memory_size = 6

  Temporary memory used by this node.

• int64 persistent_memory_size = 12

  Persistent memory used by this node.

• int64 host_temp_memory_size = 10

• int64 device_temp_memory_size = 11

• int64 device_persistent_memory_size = 16

• int64 compute_cost = 9

  Estimate of the computational cost of this node, in microseconds.

• int64 compute_time = 14

  Analytical estimate of the computational cost of this node, in microseconds.

• int64 memory_time = 15

  Analytical estimate of the memory access cost of this node, in microseconds.

• bool is_final = 7

  If true, the output is permanent: it can't be discarded, because this node is part of the "final output". Nodes may depend on final nodes.

• repeated int32 control_input = 8

  Ids of the control inputs for this node.

• bool inaccurate = 17

  Are the costs inaccurate?

Inputs of this node. They must be executed before this node can be executed. An input is a particular output of another node, specified by the node id and the output index.

Used in: Node

• int32 preceding_node = 1

• int32 preceding_port = 2

Outputs of this node.

Used in: Node

• int64 size = 1

• int64 alias_input_port = 2

  If >= 0, the output is an alias of an input. Note that an alias input may itself be an alias. The algorithm will therefore need to follow those pointers.

• optional TensorShapeProto shape = 3

• DataType dtype = 4

• repeated int32 input_tensors_needed = 1

• repeated int32 input_tensors_as_shapes_needed = 2

• optional TensorShapeProto shape = 1

• optional CppShapeInferenceResult.HandleData handle_data = 4

Used in: CppShapeInferenceResult

• bool is_set = 1

• repeated HandleShapeAndType shape_and_type = 2

  Only valid if <is_set>.

Used in: HandleData

• optional TensorShapeProto shape = 1

• DataType dtype = 2

Used in: SummaryMetadata

• DATA_CLASS_UNKNOWN = 0

  Unknown data class, used (implicitly) for legacy data. Will not be processed by data ingestion pipelines.

• DATA_CLASS_SCALAR = 1

  Scalar time series. Each `Value` for the corresponding tag must have `tensor` set to a rank-0 tensor of floating-point dtype, which will be converted to float64.

• DATA_CLASS_TENSOR = 2

  Tensor time series. Each `Value` for the corresponding tag must have `tensor` set. The tensor value is arbitrary, but should be small to accommodate direct storage in database backends: an upper bound of a few kilobytes is a reasonable rule of thumb.

• DATA_CLASS_BLOB_SEQUENCE = 3

  Blob sequence time series. Each `Value` for the corresponding tag must have `tensor` set to a rank-1 tensor of bytestring dtype.

(== suppress_warning documentation-presence ==) LINT.IfChange

Used in: AttrValue, AttrValue.ListValue, BoundedTensorSpecProto, CostGraphDef.Node.OutputInfo, CppShapeInferenceResult.HandleShapeAndType, OpDef.ArgDef, ResourceHandleProto.DtypeAndShape, SavedVariable, StructuredValue, TensorDescription, TensorInfo, TensorProto, TensorSpecProto

• DT_INVALID = 0

  Not a legal value for DataType. Used to indicate a DataType field has not been set.

• DT_FLOAT = 1

  Data types that all computation devices are expected to be capable to support.

• DT_DOUBLE = 2

• DT_INT32 = 3

• DT_UINT8 = 4

• DT_INT16 = 5

• DT_INT8 = 6

• DT_STRING = 7

• DT_COMPLEX64 = 8

  Single-precision complex

• DT_INT64 = 9

• DT_BOOL = 10

• DT_QINT8 = 11

  Quantized int8

• DT_QUINT8 = 12

  Quantized uint8

• DT_QINT32 = 13

  Quantized int32

• DT_BFLOAT16 = 14

  Float32 truncated to 16 bits. Only for cast ops.

• DT_QINT16 = 15

  Quantized int16

• DT_QUINT16 = 16

  Quantized uint16

• DT_UINT16 = 17

• DT_COMPLEX128 = 18

  Double-precision complex

• DT_HALF = 19

• DT_RESOURCE = 20

• DT_VARIANT = 21

  Arbitrary C++ data types

• DT_UINT32 = 22

• DT_UINT64 = 23

• DT_FLOAT_REF = 101

  Do not use! These are only for parameters. Every enum above should have a corresponding value below (verified by types_test).

• DT_DOUBLE_REF = 102

• DT_INT32_REF = 103

• DT_UINT8_REF = 104

• DT_INT16_REF = 105

• DT_INT8_REF = 106

• DT_STRING_REF = 107

• DT_COMPLEX64_REF = 108

• DT_INT64_REF = 109

• DT_BOOL_REF = 110

• DT_QINT8_REF = 111

• DT_QUINT8_REF = 112

• DT_QINT32_REF = 113

• DT_BFLOAT16_REF = 114

• DT_QINT16_REF = 115

• DT_QUINT16_REF = 116

• DT_UINT16_REF = 117

• DT_COMPLEX128_REF = 118

• DT_HALF_REF = 119

• DT_RESOURCE_REF = 120

• DT_VARIANT_REF = 121

• DT_UINT32_REF = 122

• DT_UINT64_REF = 123

Options for initializing DebuggerState in TensorFlow Debugger (tfdbg).

Used in: RunOptions

• repeated DebugTensorWatch debug_tensor_watch_opts = 4

  Debugging options

• int64 global_step = 10

  Caller-specified global step count. Note that this is distinct from the session run count and the executor step count.

• bool reset_disk_byte_usage = 11

  Whether the total disk usage of tfdbg is to be reset to zero in this Session.run call. This is used by wrappers and hooks such as the local CLI ones to indicate that the dumped tensors are cleaned up from the disk after each Session.run.

Option for watching a node in TensorFlow Debugger (tfdbg).

Used in: DebugOptions

• string node_name = 1

  Name of the node to watch. Use "*" for wildcard. But note: currently, regex is not supported in general.

• int32 output_slot = 2

  Output slot to watch. The semantics of output_slot == -1 is that all outputs of the node will be watched (i.e., a wildcard). Other negative values of output_slot are invalid and will lead to errors currently.

• repeated string debug_ops = 3

  Name(s) of the debugging op(s). One or more than one probes on a tensor. e.g., {"DebugIdentity", "DebugNanCount"}

• repeated string debug_urls = 4

  URL(s) for debug targets(s). Supported URL formats are: - file:///foo/tfdbg_dump: Writes out Event content to file /foo/tfdbg_dump. Assumes all directories can be created if they don't already exist. - grpc://localhost:11011: Sends an RPC request to an EventListener service running at localhost:11011 with the event. - memcbk:///event_key: Routes tensors to clients using the callback registered with the DebugCallbackRegistry for event_key. Each debug op listed in debug_ops will publish its output tensor (debug signal) to all URLs in debug_urls. N.B. Session::Run() supports concurrent invocations of the same inputs (feed keys), outputs and target nodes. If such concurrent invocations are to be debugged, the callers of Session::Run() must use distinct debug_urls to make sure that the streamed or dumped events do not overlap among the invocations. TODO(cais): More visible documentation of this in g3docs.

• bool tolerate_debug_op_creation_failures = 5

  Do not error out if debug op creation fails (e.g., due to dtype incompatibility). Instead, just log the failure.

Used in: DebuggedSourceFiles

• string host = 1

  The host name on which a source code file is located.

• string file_path = 2

  Path to the source code file.

• int64 last_modified = 3

  The timestamp at which the source code file is last modified.

• int64 bytes = 4

  Byte size of the file.

• repeated string lines = 5

  Line-by-line content of the source code file.

• repeated DebuggedSourceFile source_files = 1

  A collection of source code files.

Used in: StepStats

• string device = 1

• repeated NodeExecStats node_stats = 2

• map<uint32, string> thread_names = 3

  Its key is thread id.

Represents a Python dict keyed by `str`. The comment on Unicode from Value.string_value applies analogously.

Used in: StructuredValue

• map<string, StructuredValue> fields = 1

Protocol buffer representing an event that happened during the execution of a Brain model.

Used in: WorkerHeartbeatResponse

• double wall_time = 1

  Timestamp of the event.

• int64 step = 2

  Global step of the event.

• oneof what

  • string file_version = 3

    An event file was started, with the specified version. This is use to identify the contents of the record IO files easily. Current version is "brain.Event:2". All versions start with "brain.Event:".

  • bytes graph_def = 4

    An encoded version of a GraphDef.

  • Summary summary = 5

    A summary was generated.

  • LogMessage log_message = 6

    The user output a log message. Not all messages are logged, only ones generated via the Python tensorboard_logging module.

  • SessionLog session_log = 7

    The state of the session which can be used for restarting after crashes.

  • TaggedRunMetadata tagged_run_metadata = 8

    The metadata returned by running a session.run() call.

  • bytes meta_graph_def = 9

    An encoded version of a MetaGraphDef.

Used in: ExecProfile

• int64 memory_micros = 1

  This is the timestamp when the memory information was tracked.

• int64 host_temp_bytes = 2

  NOTE: Please don't depend on the following 4 fields yet. Due to TensorFlow internal tracing issues, the numbers can be quite wrong. TODO(xpan): Fix the TensorFlow internal tracing.

• int64 host_persistent_bytes = 3

• int64 accelerator_temp_bytes = 4

• int64 accelerator_persistent_bytes = 5

• int64 requested_bytes = 6

  Total bytes requested by the op.

• int64 peak_bytes = 7

  Total bytes requested by the op and released before op end.

• int64 residual_bytes = 8

  Total bytes requested by the op and not released after op end.

• int64 output_bytes = 9

  Total bytes output by the op (not necessarily requested by the op).

• int64 allocator_bytes_in_use = 10

  The total number of bytes currently allocated by the allocator if >0.

• map<int32, Memory> output_memory = 11

  The memory of each output of the operation.

Used in: ProfileNode

• int64 run_count = 1

  Can be larger than 1 if run multiple times in loop.

• int64 all_start_micros = 2

  The earliest/latest time including scheduling and execution.

• int64 latest_end_micros = 3

• map<string, ExecTime> accelerator_execs = 4

  device -> vector of {op_start_micros, op_exec_micros} pairs. accelerator_execs: gpu:id/stream:all -> {op_start_micros, op_exec_micros} For accelerator, vector size can be larger than 1, multiple kernel fires or in tf.while_loop.

• map<string, ExecTime> cpu_execs = 5

  cpu_execs: cpu/gpu:id -> {op_start_micros, op_exec_micros} For cpu, vector size can be larger than 1 if in tf.while_loop.

• repeated ExecMemory memory_execs = 7

  Each entry to memory information of a scheduling of the node. Normally, there will be multiple entries in while_loop.

• repeated AllocationRecord allocations = 11

  The allocation and deallocation times and sizes throughout execution.

• repeated string devices = 6

  The devices related to this execution.

Used in: ExecProfile

• repeated Tuple times = 1

A function can be instantiated when the runtime can bind every attr with a value. When a GraphDef has a call to a function, it must have binding for every attr defined in the signature. TODO(zhifengc): * device spec, etc.

Used in: FunctionDefLibrary

• optional OpDef signature = 1

  The definition of the function's name, arguments, return values, attrs etc.

• map<string, AttrValue> attr = 5

  Attributes specific to this function definition.

• map<uint32, FunctionDef.ArgAttrs> arg_attr = 7

• map<uint32, uint32> resource_arg_unique_id = 8

  Unique IDs for each resource argument, used to track aliasing resources. If Argument A and Argument B alias each other, then resource_arg_unique_ids[A.index] == resource_arg_unique_ids[B.index]. If this field is empty, none of the arguments could alias; otherwise, every resource argument should have an entry in this field. When instantiated, the unique IDs will be attached to the _Arg nodes' "_resource_arg_unique_id" attribute.

• repeated NodeDef node_def = 3

  By convention, "op" in node_def is resolved by consulting with a user-defined library first. If not resolved, "func" is assumed to be a builtin op.

• map<string, string> ret = 4

  A mapping from the output arg names from `signature` to the outputs from `node_def` that should be returned by the function.

• map<string, string> control_ret = 6

  A mapping from control output names from `signature` to node names in `node_def` which should be control outputs of this function.

Attributes for function arguments. These attributes are the same set of valid attributes as to _Arg nodes.

Used in: FunctionDef

• map<string, AttrValue> attr = 1

A library is a set of named functions.

Used in: GraphDef

• repeated FunctionDef function = 1

• repeated GradientDef gradient = 2

Represents `FunctionSpec` used in `Function`. This represents a function that has been wrapped as a TensorFlow `Function`.

Used in: SavedFunction

• optional StructuredValue fullargspec = 1

  Full arg spec from inspect.getfullargspec().

• bool is_method = 2

  Whether this represents a class method.

• optional StructuredValue input_signature = 5

  The input signature, if specified.

Used in: ConfigProto

• double per_process_gpu_memory_fraction = 1

  Fraction of the available GPU memory to allocate for each process. 1 means to allocate all of the GPU memory, 0.5 means the process allocates up to ~50% of the available GPU memory. GPU memory is pre-allocated unless the allow_growth option is enabled. If greater than 1.0, uses CUDA unified memory to potentially oversubscribe the amount of memory available on the GPU device by using host memory as a swap space. Accessing memory not available on the device will be significantly slower as that would require memory transfer between the host and the device. Options to reduce the memory requirement should be considered before enabling this option as this may come with a negative performance impact. Oversubscription using the unified memory requires Pascal class or newer GPUs and it is currently only supported on the Linux operating system. See https://docs.nvidia.com/cuda/cuda-c-programming-guide/index.html#um-requirements for the detailed requirements.

• bool allow_growth = 4

  If true, the allocator does not pre-allocate the entire specified GPU memory region, instead starting small and growing as needed.

• string allocator_type = 2

  The type of GPU allocation strategy to use. Allowed values: "": The empty string (default) uses a system-chosen default which may change over time. "BFC": A "Best-fit with coalescing" algorithm, simplified from a version of dlmalloc.

• int64 deferred_deletion_bytes = 3

  Delay deletion of up to this many bytes to reduce the number of interactions with gpu driver code. If 0, the system chooses a reasonable default (several MBs).

• string visible_device_list = 5

  A comma-separated list of GPU ids that determines the 'visible' to 'virtual' mapping of GPU devices. For example, if TensorFlow can see 8 GPU devices in the process, and one wanted to map visible GPU devices 5 and 3 as "/device:GPU:0", and "/device:GPU:1", then one would specify this field as "5,3". This field is similar in spirit to the CUDA_VISIBLE_DEVICES environment variable, except it applies to the visible GPU devices in the process. NOTE: 1. The GPU driver provides the process with the visible GPUs in an order which is not guaranteed to have any correlation to the *physical* GPU id in the machine. This field is used for remapping "visible" to "virtual", which means this operates only after the process starts. Users are required to use vendor specific mechanisms (e.g., CUDA_VISIBLE_DEVICES) to control the physical to visible device mapping prior to invoking TensorFlow. 2. In the code, the ids in this list are also called "platform GPU id"s, and the 'virtual' ids of GPU devices (i.e. the ids in the device name "/device:GPU:<id>") are also called "TF GPU id"s. Please refer to third_party/tensorflow/core/common_runtime/gpu/gpu_id.h for more information.

• int32 polling_active_delay_usecs = 6

  In the event polling loop sleep this many microseconds between PollEvents calls, when the queue is not empty. If value is not set or set to 0, gets set to a non-zero default.

• int32 polling_inactive_delay_msecs = 7

  This field is deprecated and ignored.

• bool force_gpu_compatible = 8

  Force all tensors to be gpu_compatible. On a GPU-enabled TensorFlow, enabling this option forces all CPU tensors to be allocated with Cuda pinned memory. Normally, TensorFlow will infer which tensors should be allocated as the pinned memory. But in case where the inference is incomplete, this option can significantly speed up the cross-device memory copy performance as long as it fits the memory. Note that this option is not something that should be enabled by default for unknown or very large models, since all Cuda pinned memory is unpageable, having too much pinned memory might negatively impact the overall host system performance.

• optional GPUOptions.Experimental experimental = 9

  Everything inside experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.

Used in: GPUOptions

• repeated Experimental.VirtualDevices virtual_devices = 1

  The multi virtual device settings. If empty (not set), it will create single virtual device on each visible GPU, according to the settings in "visible_device_list" above. Otherwise, the number of elements in the list must be the same as the number of visible GPUs (after "visible_device_list" filtering if it is set), and the string represented device names (e.g. /device:GPU:<id>) will refer to the virtual devices and have the <id> field assigned sequentially starting from 0, according to the order they appear in this list and the "memory_limit" list inside each element. For example, visible_device_list = "1,0" virtual_devices { memory_limit: 1GB memory_limit: 2GB } virtual_devices {} will create three virtual devices as: /device:GPU:0 -> visible GPU 1 with 1GB memory /device:GPU:1 -> visible GPU 1 with 2GB memory /device:GPU:2 -> visible GPU 0 with all available memory NOTE: 1. It's invalid to set both this and "per_process_gpu_memory_fraction" at the same time. 2. Currently this setting is per-process, not per-session. Using different settings in different sessions within same process will result in undefined behavior.

• bool use_unified_memory = 2

  If true, uses CUDA unified memory for memory allocations. If per_process_gpu_memory_fraction option is greater than 1.0, then unified memory is used regardless of the value for this field. See comments for per_process_gpu_memory_fraction field for more details and requirements of the unified memory. This option is useful to oversubscribe memory if multiple processes are sharing a single GPU while individually using less than 1.0 per process memory fraction.

• int32 num_dev_to_dev_copy_streams = 3

  If > 1, the number of device-to-device copy streams to create for each GPUDevice. Default value is 0, which is automatically converted to 1.

• string collective_ring_order = 4

  If non-empty, defines a good GPU ring order on a single worker based on device interconnect. This assumes that all workers have the same GPU topology. Specify as a comma-separated string, e.g. "3,2,1,0,7,6,5,4". This ring order is used by the RingReducer implementation of CollectiveReduce, and serves as an override to automatic ring order generation in OrderTaskDeviceMap() during CollectiveParam resolution.

• bool timestamped_allocator = 5

  If true then extra work is done by GPUDevice and GPUBFCAllocator to keep track of when GPU memory is freed and when kernels actually complete so that we can know when a nominally free memory chunk is really not subject to pending use.

• int32 kernel_tracker_max_interval = 7

  Parameters for GPUKernelTracker. By default no kernel tracking is done. Note that timestamped_allocator is only effective if some tracking is specified. If kernel_tracker_max_interval = n > 0, then a tracking event is inserted after every n kernels without an event.

• int32 kernel_tracker_max_bytes = 8

  If kernel_tracker_max_bytes = n > 0, then a tracking event is inserted after every series of kernels allocating a sum of memory >= n. If one kernel allocates b * n bytes, then one event will be inserted after it, but it will count as b against the pending limit.

• int32 kernel_tracker_max_pending = 9

  If kernel_tracker_max_pending > 0 then no more than this many tracking events can be outstanding at a time. An attempt to launch an additional kernel will stall until an event completes.

Configuration for breaking down a visible GPU into multiple "virtual" devices.

Used in: Experimental

• repeated float memory_limit_mb = 1

  Per "virtual" device memory limit, in MB. The number of elements in the list is the number of virtual devices to create on the corresponding visible GPU (see "virtual_devices" below). If empty, it will create single virtual device taking all available memory from the device. For the concept of "visible" and "virtual" GPU, see the comments for "visible_device_list" above for more information.

• repeated int32 priority = 2

  Priority values to use with the virtual devices. Use the cuda function cudaDeviceGetStreamPriorityRange to query for valid range of values for priority. On a P4000 GPU with cuda 10.1, the priority range reported was 0 for least priority and -1 for greatest priority. If this field is not specified, then the virtual devices will be created with the default. If this field has values set, then the size of this must match with the above memory_limit_mb.

GradientDef defines the gradient function of a function defined in a function library. A gradient function g (specified by gradient_func) for a function f (specified by function_name) must follow the following: The function 'f' must be a numerical function which takes N inputs and produces M outputs. Its gradient function 'g', which is a function taking N + M inputs and produces N outputs. I.e. if we have (y1, y2, ..., y_M) = f(x1, x2, ..., x_N), then, g is (dL/dx1, dL/dx2, ..., dL/dx_N) = g(x1, x2, ..., x_N, dL/dy1, dL/dy2, ..., dL/dy_M), where L is a scalar-value function of (x1, x2, ..., xN) (e.g., the loss function). dL/dx_i is the partial derivative of L with respect to x_i.

Used in: FunctionDefLibrary

• string function_name = 1

  The function name.

• string gradient_func = 2

  The gradient function's name.

Represents the graph of operations

Used in: MetaGraphDef, RunMetadata, RunMetadata.FunctionGraphs

• repeated NodeDef node = 1

• optional VersionDef versions = 4

  Compatibility versions of the graph. See core/public/version.h for version history. The GraphDef version is distinct from the TensorFlow version, and each release of TensorFlow will support a range of GraphDef versions.

• int32 version = 3

  Deprecated single version field; use versions above instead. Since all GraphDef changes before "versions" was introduced were forward compatible, this field is entirely ignored.

• optional FunctionDefLibrary library = 2

  EXPERIMENTAL. DO NOT USE OR DEPEND ON THIS YET. "library" provides user-defined functions. Naming: * library.function.name are in a flat namespace. NOTE: We may need to change it to be hierarchical to support different orgs. E.g., { "/google/nn", { ... }}, { "/google/vision", { ... }} { "/org_foo/module_bar", { ... }} map<string, FunctionDefLib> named_lib; * If node[i].op is the name of one function in "library", node[i] is deemed as a function call. Otherwise, node[i].op must be a primitive operation supported by the runtime. Function call semantics: * The callee may start execution as soon as some of its inputs are ready. The caller may want to use Tuple() mechanism to ensure all inputs are ready in the same time. * The consumer of return values may start executing as soon as the return values the consumer depends on are ready. The consumer may want to use Tuple() mechanism to ensure the consumer does not start until all return values of the callee function are ready.

Used in: ConfigProto

• bool enable_recv_scheduling = 2

  If true, use control flow to schedule the activation of Recv nodes. (Currently ignored.)

• optional OptimizerOptions optimizer_options = 3

  Options controlling how graph is optimized.

• int64 build_cost_model = 4

  The number of steps to run before returning a cost model detailing the memory usage and performance of each node of the graph. 0 means no cost model.

• int64 build_cost_model_after = 9

  The number of steps to skip before collecting statistics for the cost model.

• bool infer_shapes = 5

  Annotate each Node with Op output shape data, to the extent it can be statically inferred.

• bool place_pruned_graph = 6

  Only place the subgraphs that are run, rather than the entire graph. This is useful for interactive graph building, where one might produce graphs that cannot be placed during the debugging process. In particular, it allows the client to continue work in a session after adding a node to a graph whose placement constraints are unsatisfiable.

• bool enable_bfloat16_sendrecv = 7

  If true, transfer float values between processes as bfloat16.

• int32 timeline_step = 8

  If > 0, record a timeline every this many steps. EXPERIMENTAL: This currently has no effect in MasterSession.

• optional RewriterConfig rewrite_options = 10

  Options that control the type and amount of graph rewriting. Not currently configurable via the public Python API (i.e. there is no API stability guarantee if you import RewriterConfig explicitly).

Histogram summaries created by the `tensorboard.plugins.histogram.summary` module will include `SummaryMetadata` whose `plugin_data` field has as `content` a binary string that is the encoding of a `HistogramPluginData` proto.

• int32 version = 1

  Version `0` is the only supported version.

Serialization format for histogram module in core/lib/histogram/histogram.h

Used in: Summary.Value

• double min = 1

• double max = 2

• double num = 3

• double sum = 4

• double sum_squares = 5

• repeated double bucket_limit = 6

  Parallel arrays encoding the bucket boundaries and the bucket values. bucket(i) is the count for the bucket i. The range for a bucket is: i == 0: -DBL_MAX .. bucket_limit(0) i != 0: bucket_limit(i-1) .. bucket_limit(i)

• repeated double bucket = 7

Image summaries created by the `tensorboard.plugins.image.summary` module will include `SummaryMetadata` whose `plugin_data` field has as `content` a binary string that is the encoding of an `ImagePluginData` proto.

• int32 version = 1

  Version `0` is the only supported version.

Defines a single job in a TensorFlow cluster.

Used in: ClusterDef

• string name = 1

  The name of this job.

• map<int32, string> tasks = 2

  Mapping from task ID to "hostname:port" string. If the `name` field contains "worker", and the `tasks` map contains a mapping from 7 to "example.org:2222", then the device prefix "/job:worker/task:7" will be assigned to "example.org:2222".

* A layout encapsulates how charts are laid out within the custom scalars dashboard.

• int32 version = 1

  Version `0` is the only supported version.

• repeated Category category = 2

  The categories here are rendered from top to bottom.

Represents a Python list.

Used in: StructuredValue

• repeated StructuredValue values = 1

Protocol buffer used for logging messages to the events file.

Used in: Event

• LogMessage.Level level = 1

• string message = 2

Used in: LogMessage

• UNKNOWN = 0

• DEBUGGING = 10

  Note: The logging level 10 cannot be named DEBUG. Some software projects compile their C/C++ code with -DDEBUG in debug builds. So the C++ code generated from this file should not have an identifier named DEBUG.

• INFO = 20

• WARN = 30

• ERROR = 40

• FATAL = 50

* Encapsulates information on a single margin chart. A margin chart uses fill area to visualize lower and upper bounds that surround a value.

Used in: Chart

• repeated MarginChartContent.Series series = 1

  A list of data series to include within this margin chart.

* Encapsulates a tag of data for the chart.

Used in: MarginChartContent

• string value = 1

  The exact tag string associated with the scalar summaries making up the main value between the bounds.

• string lower = 2

  The exact tag string associated with the scalar summaries making up the lower bound.

• string upper = 3

  The exact tag string associated with the scalar summaries making up the upper bound.

Used in: ExecMemory

• int64 bytes = 1

• uint64 ptr = 2

For memory tracking.

Used in: NodeExecStats

• int64 temp_memory_size = 1

• int64 persistent_memory_size = 3

• repeated int64 persistent_tensor_alloc_ids = 5

• int64 device_temp_memory_size = 2

• int64 device_persistent_memory_size = 4

• repeated int64 device_persistent_tensor_alloc_ids = 6

NOTE: This protocol buffer is evolving, and will go through revisions in the coming months. Protocol buffer containing the following which are necessary to restart training, run inference. It can be used to serialize/de-serialize memory objects necessary for running computation in a graph when crossing the process boundary. It can be used for long term storage of graphs, cross-language execution of graphs, etc. MetaInfoDef GraphDef SaverDef CollectionDef TensorInfo SignatureDef

• optional MetaGraphDef.MetaInfoDef meta_info_def = 1

• optional GraphDef graph_def = 2

  GraphDef.

• optional SaverDef saver_def = 3

  SaverDef.

• map<string, CollectionDef> collection_def = 4

  collection_def: Map from collection name to collections. See CollectionDef section for details.

• map<string, SignatureDef> signature_def = 5

  signature_def: Map from user supplied key for a signature to a single SignatureDef.

• repeated AssetFileDef asset_file_def = 6

  Asset file def to be used with the defined graph.

• optional SavedObjectGraph object_graph_def = 7

  Extra information about the structure of functions and stateful objects.

Meta information regarding the graph to be exported. To be used by users of this protocol buffer to encode information regarding their meta graph.

Used in: MetaGraphDef

• string meta_graph_version = 1

  User specified Version string. Can be the name of the model and revision, steps this model has been trained to, etc.

• optional OpList stripped_op_list = 2

  A copy of the OpDefs used by the producer of this graph_def. Descriptions and Ops not used in graph_def are stripped out.

• optional google.protobuf.Any any_info = 3

  A serialized protobuf. Can be the time this meta graph is created, or modified, or name of the model.

• repeated string tags = 4

  User supplied tag(s) on the meta_graph and included graph_def. MetaGraphDefs should be tagged with their capabilities or use-cases. Examples: "train", "serve", "gpu", "tpu", etc. These tags enable loaders to access the MetaGraph(s) appropriate for a specific use-case or runtime environment.

• string tensorflow_version = 5

  The __version__ string of the tensorflow build used to write this graph. This will be populated by the framework, which will overwrite any user supplied value.

• string tensorflow_git_version = 6

  The __git_version__ string of the tensorflow build used to write this graph. This will be populated by the framework, which will overwrite any user supplied value.

• bool stripped_default_attrs = 7

  A flag to denote whether default-valued attrs have been stripped from the nodes in this graph_def.

• map<string, string> function_aliases = 8

  FunctionDef name to aliases mapping.

* Encapsulates information on a single line chart. This line chart may have lines associated with several tags.

Used in: Chart

• repeated string tag = 1

  A list of regular expressions for tags that should appear in this chart. Tags are matched from beginning to end. Each regex captures a set of tags.

A list of attr names and their values. The whole list is attached with a string name. E.g., MatMul[T=float].

Used in: AttrValue, AttrValue.ListValue

• string name = 1

• map<string, AttrValue> attr = 2

Represents Python's namedtuple.

Used in: StructuredValue

• string name = 1

• repeated PairValue values = 2

Used in: FunctionDef, GraphDef

• string name = 1

  The name given to this operator. Used for naming inputs, logging, visualization, etc. Unique within a single GraphDef. Must match the regexp "[A-Za-z0-9.][A-Za-z0-9_>./]*".

• string op = 2

  The operation name. There may be custom parameters in attrs. Op names starting with an underscore are reserved for internal use.

• repeated string input = 3

  Each input is "node:src_output" with "node" being a string name and "src_output" indicating which output tensor to use from "node". If "src_output" is 0 the ":0" suffix can be omitted. Regular inputs may optionally be followed by control inputs that have the format "^node".

• string device = 4

  A (possibly partial) specification for the device on which this node should be placed. The expected syntax for this string is as follows: DEVICE_SPEC ::= PARTIAL_SPEC PARTIAL_SPEC ::= ("/" CONSTRAINT) * CONSTRAINT ::= ("job:" JOB_NAME) | ("replica:" [1-9][0-9]*) | ("task:" [1-9][0-9]*) | ("device:" [A-Za-z]* ":" ([1-9][0-9]* | "*") ) Valid values for this string include: * "/job:worker/replica:0/task:1/device:GPU:3" (full specification) * "/job:worker/device:GPU:3" (partial specification) * "" (no specification) If the constraints do not resolve to a single device (or if this field is empty or not present), the runtime will attempt to choose a device automatically.

• map<string, AttrValue> attr = 5

  Operation-specific graph-construction-time configuration. Note that this should include all attrs defined in the corresponding OpDef, including those with a value matching the default -- this allows the default to change and makes NodeDefs easier to interpret on their own. However, if an attr with a default is not specified in this list, the default will be used. The "names" (keys) must match the regexp "[a-z][a-z0-9_]+" (and one of the names from the corresponding OpDef's attr field). The values must have a type matching the corresponding OpDef attr's type field. TODO(josh11b): Add some examples here showing best practices.

• optional NodeDef.ExperimentalDebugInfo experimental_debug_info = 6

  This stores debug information associated with the node.

Used in: NodeDef

• repeated string original_node_names = 1

  Opaque string inserted into error messages created by the runtime. This is intended to store the list of names of the nodes from the original graph that this node was derived. For example if this node, say C, was result of a fusion of 2 nodes A and B, then 'original_node' would be {A, B}. This information can be used to map errors originating at the current node to some top level source code.

• repeated string original_func_names = 2

  This is intended to store the list of names of the functions from the original graph that this node was derived. For example if this node, say C, was result of a fusion of node A in function FA and node B in function FB, then `original_funcs` would be {FA, FB}. If the node is in the top level graph, the `original_func` is empty. This information, with the `original_node_names` can be used to map errors originating at the current ndoe to some top level source code.

Time/size stats recorded for a single execution of a graph node.

Used in: DeviceStepStats

• string node_name = 1

  TODO(tucker): Use some more compact form of node identity than the full string name. Either all processes should agree on a global id (cost_id?) for each node, or we should use a hash of the name.

• int64 all_start_micros = 2

• int64 op_start_rel_micros = 3

• int64 op_end_rel_micros = 4

• int64 all_end_rel_micros = 5

• repeated AllocatorMemoryUsed memory = 6

• repeated NodeOutput output = 7

• string timeline_label = 8

• int64 scheduled_micros = 9

• uint32 thread_id = 10

• repeated AllocationDescription referenced_tensor = 11

• optional MemoryStats memory_stats = 12

• int64 all_start_nanos = 13

• int64 op_start_rel_nanos = 14

• int64 op_end_rel_nanos = 15

• int64 all_end_rel_nanos = 16

• int64 scheduled_nanos = 17

Output sizes recorded for a single execution of a graph node.

Used in: NodeExecStats

• int32 slot = 1

• optional TensorDescription tensor_description = 3

Represents None.

Used in: StructuredValue

(message has no fields)

nPMI summaries created by the `tensorboard.plugins.npmi.summary` module will include `SummaryMetadata` whose `plugin_data` field has as `content` a binary string that is the encoding of an `NpmiPluginData` proto.

• int32 version = 1

  Version `0` is the only supported version.

Defines an operation. A NodeDef in a GraphDef specifies an Op by using the "op" field which should match the name of a OpDef. LINT.IfChange

Used in: FunctionDef, OpList

• string name = 1

  Op names starting with an underscore are reserved for internal use. Names should be CamelCase and match the regexp "[A-Z][a-zA-Z0-9>_]*".

• repeated OpDef.ArgDef input_arg = 2

  Description of the input(s).

• repeated OpDef.ArgDef output_arg = 3

  Description of the output(s).

• repeated string control_output = 20

  Named control outputs for this operation. Useful only for composite operations (i.e. functions) which want to name different control outputs.

• repeated OpDef.AttrDef attr = 4

• optional OpDeprecation deprecation = 8

  Optional deprecation based on GraphDef versions.

• string summary = 5

  One-line human-readable description of what the Op does.

• string description = 6

  Additional, longer human-readable description of what the Op does.

• bool is_commutative = 18

  True if the operation is commutative ("op(a,b) == op(b,a)" for all inputs)

• bool is_aggregate = 16

  If is_aggregate is true, then this operation accepts N >= 2 inputs and produces 1 output all of the same type. Should be associative and commutative, and produce output with the same shape as the input. The optimizer may replace an aggregate op taking input from multiple devices with a tree of aggregate ops that aggregate locally within each device (and possibly within groups of nearby devices) before communicating. TODO(josh11b): Implement that optimization.

  for things like add

• bool is_stateful = 17

  Ops are marked as stateful if their behavior depends on some state beyond their input tensors (e.g. variable reading op) or if they have a side-effect (e.g. printing or asserting ops). Equivalently, stateless ops must always produce the same output for the same input and have no side-effects. By default Ops may be moved between devices. Stateful ops should either not be moved, or should only be moved if that state can also be moved (e.g. via some sort of save / restore). Stateful ops are guaranteed to never be optimized away by Common Subexpression Elimination (CSE).

  for things like variables, queue

• bool allows_uninitialized_input = 19

  By default, all inputs to an Op must be initialized Tensors. Ops that may initialize tensors for the first time should set this field to true, to allow the Op to take an uninitialized Tensor as input.

  for Assign, etc.

For describing inputs and outputs.

Used in: OpDef

• string name = 1

  Name for the input/output. Should match the regexp "[a-z][a-z0-9_]*".

• string description = 2

  Human readable description.

• DataType type = 3

  Describes the type of one or more tensors that are accepted/produced by this input/output arg. The only legal combinations are: * For a single tensor: either the "type" field is set or the "type_attr" field is set to the name of an attr with type "type". * For a sequence of tensors with the same type: the "number_attr" field will be set to the name of an attr with type "int", and either the "type" or "type_attr" field will be set as for single tensors. * For a sequence of tensors, the "type_list_attr" field will be set to the name of an attr with type "list(type)".

• string type_attr = 4

  if specified, attr must have type "type"

• string number_attr = 5

  if specified, attr must have type "int"

• string type_list_attr = 6

  If specified, attr must have type "list(type)", and none of type, type_attr, and number_attr may be specified.

• bool is_ref = 16

  For inputs: if true, the inputs are required to be refs. By default, inputs can be either refs or non-refs. For outputs: if true, outputs are refs, otherwise they are not.

Description of the graph-construction-time configuration of this Op. That is to say, this describes the attr fields that will be specified in the NodeDef.

Used in: OpDef

• string name = 1

  A descriptive name for the argument. May be used, e.g. by the Python client, as a keyword argument name, and so should match the regexp "[a-z][a-z0-9_]+".

• string type = 2

  One of the type names from attr_value.proto ("string", "list(string)", "int", etc.).

• optional AttrValue default_value = 3

  A reasonable default for this attribute if the user does not supply a value. If not specified, the user must supply a value.

• string description = 4

  Human-readable description.

• bool has_minimum = 5

  For type == "int", this is a minimum value. For "list(___)" types, this is the minimum length.

• int64 minimum = 6

• optional AttrValue allowed_values = 7

  The set of allowed values. Has type that is the "list" version of the "type" field above (uses the "list" field of AttrValue). If type == "type" or "list(type)" above, then the "type" field of "allowed_values.list" has the set of allowed DataTypes. If type == "string" or "list(string)", then the "s" field of "allowed_values.list" has the set of allowed strings.

Information about version-dependent deprecation of an op

Used in: OpDef

• int32 version = 1

  First GraphDef version at which the op is disallowed.

• string explanation = 2

  Explanation of why it was deprecated and what to use instead.

A collection of OpDefs

Used in: MetaGraphDef.MetaInfoDef

• repeated OpDef op = 1

Used in: OpLogProto

• string name = 1

  op name.

• int64 float_ops = 2

  float_ops is filled by tfprof Python API when called. It requires the op has RegisterStatistics defined. Currently, Conv2D, MatMul, etc, are implemented.

• repeated string types = 3

  User can define extra op type information for an op. This allows the user to select a group of ops precisely using op_type as a key.

• optional CodeDef code_def = 4

  Used to support tfprof "code" view.

• repeated OpLogEntry log_entries = 1

• map<int64, string> id_to_string = 2

  Maps from id of CodeDef file,function,line to its string In the future can also map other id of other fields to string.

Options passed to the graph optimizer

Used in: GraphOptions

• bool do_common_subexpression_elimination = 1

  If true, optimize the graph using common subexpression elimination.

• bool do_constant_folding = 2

  If true, perform constant folding optimization on the graph.

• int64 max_folded_constant_in_bytes = 6

  Constant folding optimization replaces tensors whose values can be predetermined, with constant nodes. To avoid inserting too large constants, the size of each constant created can be limited. If this value is zero, a default limit of 10 MiB will be applied. If constant folding optimization is disabled, this value is ignored.

• bool do_function_inlining = 4

  If true, perform function inlining on the graph.

• OptimizerOptions.Level opt_level = 3

  Overall optimization level. The actual optimizations applied will be the logical OR of the flags that this level implies and any flags already set.

• OptimizerOptions.GlobalJitLevel global_jit_level = 5

Control the use of the compiler/jit. Experimental.

Used in: OptimizerOptions

• DEFAULT = 0

  Default setting ("off" now, but later expected to be "on")

• OFF = -1

• ON_1 = 1

  The following settings turn on compilation, with higher values being more aggressive. Higher values may reduce opportunities for parallelism and may use more memory. (At present, there is no distinction, but this is expected to change.)

• ON_2 = 2

Optimization level

Used in: OptimizerOptions

• L1 = 0

  L1 is the default level. Optimization performed at L1 : 1. Common subexpression elimination 2. Constant folding

• L0 = -1

  No optimizations

Represents a (key, value) pair.

Used in: NamedTupleValue

• string key = 1

• optional StructuredValue value = 2

• int32 version = 1

  Version `0` is the only supported version.

• uint32 num_thresholds = 2

Used in: ProfileProto

• string name = 1

  graph node name.

• string op = 9

  graph operation type.

• int64 id = 13

  A unique id for the node.

• map<int32, int64> inputs = 2

• map<int32, Tuple> input_shapes = 16

• map<int32, int64> outputs = 3

• map<int32, Tuple> output_shapes = 15

• map<int64, int32> src_output_index = 14

  A map from source node id to its output index to current node.

• repeated int64 shape = 4

• repeated string op_types = 5

• string canonical_device = 6

• string host_device = 7

• int64 float_ops = 8

• optional CodeDef trace = 10

• map<string, AttrValue> attrs = 11

• map<int64, ExecProfile> execs = 12

A proto representation of the profiler's profile. It allows serialization, shipping around and deserialization of the profiles. Please don't depend on the internals of the profile proto.

• map<int64, ProfileNode> nodes = 1

• bool has_trace = 2

  Whether or not has code traces.

• bool miss_accelerator_stream = 5

  Whether or not the TF device tracer fails to return accelerator information (which could lead to 0 accelerator execution time).

• repeated int64 steps = 3

  Traced steps.

• map<int64, string> id_to_string = 4

  Maps from id of CodeDef file,function,line to its string In the future can also map other id of other fields to string.

Used in: ConfigProto

• bool use_rpc_for_inprocess_master = 1

  If true, always use RPC to contact the session target. If false (the default option), TensorFlow may use an optimized transport for client-master communication that avoids the RPC stack. This option is primarily for used testing the RPC stack.

• string compression_algorithm = 2

  The compression algorithm to be used. One of "deflate", "gzip".

• int32 compression_level = 3

  If compression_algorithm is set, the compression level to be used. From 0 (no compression), up to 3.

• bool cache_rpc_response = 4

  Setting cache_rpc_response to true will enable sender side caching of response for RecvTensorAsync and RecvBufAsync to allow receiver to retry requests . This is only necessary when the network fabric is experiencing a significant error rate. Without it we'll fail a step on an network error, while with it we'll be able to complete long steps (like complex initializations) in the face of some network errors during RecvTensor.

• bool disable_session_connection_sharing = 5

  Disables TCP connection sharing when opening a new RPC channel.

Used in: WorkerHeartbeatRequest

• int32 exit_code = 1

Protocol buffer representing a handle to a tensorflow resource. Handles are not valid across executions, but can be serialized back and forth from within a single run.

Used in: TensorProto

• string device = 1

  Unique name for the device containing the resource.

• string container = 2

  Container in which this resource is placed.

• string name = 3

  Unique name of this resource.

• uint64 hash_code = 4

  Hash code for the type of the resource. Is only valid in the same device and in the same execution.

• string maybe_type_name = 5

  For debug-only, the name of the type pointed to by this handle, if available.

• repeated ResourceHandleProto.DtypeAndShape dtypes_and_shapes = 6

  Data types and shapes for the underlying resource.

Protocol buffer representing a pair of (data type, tensor shape).

Used in: ResourceHandleProto

• DataType dtype = 1

• optional TensorShapeProto shape = 2

Graph rewriting is experimental and subject to change, not covered by any API stability guarantees.

Used in: GraphOptions

• RewriterConfig.CpuLayout cpu_layout_conversion = 50

  CPU Conversion settings between NHCW and NCHW.

• RewriterConfig.Toggle layout_optimizer = 1

  Optimize tensor layouts (default is ON) e.g. This will try to use NCHW layout on GPU which is faster.

• RewriterConfig.Toggle constant_folding = 3

  Fold constants (default is ON) Statically infer the value of tensors when possible, and materialize the result using constants.

• RewriterConfig.Toggle shape_optimization = 13

  Shape optimizations (default is ON) Simplify computations made on shapes.

• RewriterConfig.Toggle remapping = 14

  Remapping (default is ON) Remap subgraphs onto more efficient implementations.

• RewriterConfig.Toggle common_subgraph_elimination = 24

  Common subgraph elimination (default is ON) e.g. Simplify arithmetic ops; merge ops with same value (like constants).

• RewriterConfig.Toggle arithmetic_optimization = 7

  Arithmetic optimizations (default is ON) e.g. Simplify arithmetic ops; merge ops with same value (like constants).

• RewriterConfig.Toggle dependency_optimization = 8

  Control dependency optimizations (default is ON). Remove redundant control dependencies, which may enable other optimization.

• RewriterConfig.Toggle loop_optimization = 9

  Loop optimizations (default is ON).

• RewriterConfig.Toggle function_optimization = 10

  Function optimizations (default is ON).

• RewriterConfig.Toggle debug_stripper = 11

  Strips debug-related nodes from the graph (off by default).

• bool disable_model_pruning = 2

  If true, don't remove unnecessary ops from the graph

• RewriterConfig.Toggle scoped_allocator_optimization = 15

  Try to allocate some independent Op outputs contiguously in order to merge or eliminate downstream Ops (off by default).

• RewriterConfig.Toggle pin_to_host_optimization = 18

  Force small ops onto the CPU (default is OFF).

• RewriterConfig.Toggle implementation_selector = 22

  Enable the swap of kernel implementations based on the device placement (default is ON).

• RewriterConfig.Toggle auto_mixed_precision = 23

  Optimize data types for CUDA (default is OFF). This will try to use float16 on GPU which is faster. Note that this can change the numerical stability of the graph and may require the use of loss scaling to maintain model convergence.

• RewriterConfig.Toggle auto_mixed_precision_mkl = 25

  Optimize data types for MKL (default is OFF). This will try to use bfloat16 on CPUs, which is faster. Note that this can change the numerical stability of the graph.

• bool disable_meta_optimizer = 19

  Disable the entire meta optimizer (off by default).

• RewriterConfig.NumIterationsType meta_optimizer_iterations = 12

  Controls how many times we run the optimizers in meta optimizer (default is once).

• int32 min_graph_nodes = 17

  The minimum number of nodes in a graph to optimizer. For smaller graphs, optimization is skipped. 0 means the system picks an appropriate number. < 0 means do not skip optimization.

• bool experimental_disable_compressed_tensor_optimization = 26

  Disable optimizations that assume compressed tensors. Note that this flag is experimental and may be removed in the future.

• RewriterConfig.MemOptType memory_optimization = 4

  Configures memory optimization passes through the meta-optimizer. Has no effect on manually requested memory optimization passes in the optimizers field.

• string memory_optimizer_target_node_name_scope = 6

  A node name scope for node names which are valid outputs of recomputations. Inputs to nodes that match this scope may be recomputed (subject either to manual annotation of those input nodes or to manual annotation and heuristics depending on memory_optimization), but the nodes themselves will not be recomputed. This matches any sub-scopes as well, meaning the scope can appear not just as a top-level scope. For example, if the value is "gradients/", the default, it will match node name "gradients/foo", "foo/gradients/bar", but not "foo_gradients/"

• int64 meta_optimizer_timeout_ms = 20

  Maximum number of milliseconds to spend optimizing a single graph before timing out. If equal to 0 the system picks a default (currently 5 minutes). If less than 0 the optimizer will never time out.

• optional AutoParallelOptions auto_parallel = 5

  Configures AutoParallel optimization passes either through the meta-optimizer or when manually specified through the optimizers field.

• bool fail_on_optimizer_errors = 21

  If true, any optimization pass failing will cause the MetaOptimizer to stop with an error. By default - or when set to false, failing passes are skipped silently.

• optional ScopedAllocatorOptions scoped_allocator_opts = 16

• repeated string optimizers = 100

  If non-empty, will use this as an alternative way to specify a list of optimizations to turn on and the order of the optimizations (replacing the meta-optimizer). Of the RewriterConfig options, only the AutoParallel configuration options (the auto_parallel field) apply to manually requested optimization passes ("autoparallel"). Memory optimization passes ("memory") invoked here are not configurable (in contrast to memory optimization passes through the meta-optimizer) and act only on manual op annotations. Custom optimizers (see custom_optimizers) that are not part of this schedule will be run after - in the order that they were specified.

• repeated RewriterConfig.CustomGraphOptimizer custom_optimizers = 200

  list of CustomGraphOptimizers to apply.

• optional VerifierConfig inter_optimizer_verifier_config = 300

  VerifierConfig specifying the verifiers to be run after every optimizer.

• optional VerifierConfig post_optimization_verifier_config = 301

  VerifierConfig specifying the verifiers to be run at the end, after all optimizers have run.

Enum for layout conversion between NCHW and NHWC on CPU. Default is OFF.

Used in: RewriterConfig

• NO_CONVERSION_ON_CPU = 0

• NCHW_TO_NHWC = 1

• NHWC_TO_NCHW = 2

Message to describe custom graph optimizer and its parameters

Used in: RewriterConfig

• string name = 1

• map<string, AttrValue> parameter_map = 2

Used in: RewriterConfig

• DEFAULT_MEM_OPT = 0

  The default setting (SCHEDULING and SWAPPING HEURISTICS only)

• NO_MEM_OPT = 1

  Disabled in the meta-optimizer.

• MANUAL = 2

  Driven by manual op-level annotations.

• SWAPPING_HEURISTICS = 4

  Swapping heuristic will move a tensor from the GPU to the CPU and move it back when needed to reduce peak memory usage.

• RECOMPUTATION_HEURISTICS = 5

  Recomputation heuristics will recompute ops (such as Relu activation) during backprop instead of storing them, reducing peak memory usage.

• SCHEDULING_HEURISTICS = 6

  Scheduling will split big ops such as AddN and try to enforce a schedule of the new computations that decreases peak memory usage.

• HEURISTICS = 3

  Use any combination of swapping and recomputation heuristics.

Enum controlling the number of times to run optimizers. The default is to run them twice.

Used in: RewriterConfig

• DEFAULT_NUM_ITERS = 0

• ONE = 1

• TWO = 2

Used in: RewriterConfig

• DEFAULT = 0

• ON = 1

• OFF = 2

• AGGRESSIVE = 3

  Enable some aggressive optimizations that use assumptions that TF graphs may break. For example, assume the shape of a placeholder matches its actual feed.

Metadata output (i.e., non-Tensor) for a single Run() call.

• optional StepStats step_stats = 1

  Statistics traced for this step. Populated if tracing is turned on via the "RunOptions" proto. EXPERIMENTAL: The format and set of events may change in future versions.

• optional CostGraphDef cost_graph = 2

  The cost graph for the computation defined by the run call.

• repeated GraphDef partition_graphs = 3

  Graphs of the partitions executed by executors.

• repeated RunMetadata.FunctionGraphs function_graphs = 4

  This is only populated for graphs that are run as functions in TensorFlow V2. There will be an entry below for each function that is traced. The main use cases of the post_optimization_graph and the partition_graphs is to give the caller insight into the graphs that were actually run by the runtime. Additional information (such as those in step_stats) will match these graphs. We also include the pre_optimization_graph since it is usually easier to read, and is helpful in situations where the caller wants to get a high level idea of what the built graph looks like (since the various graph optimization passes might change the structure of the graph significantly).

Used in: RunMetadata

• repeated GraphDef partition_graphs = 1

  TODO(nareshmodi): Include some sort of function/cache-key identifier?

• optional GraphDef pre_optimization_graph = 2

• optional GraphDef post_optimization_graph = 3

Options for a single Run() call.

Used in: CallableOptions

• RunOptions.TraceLevel trace_level = 1

• int64 timeout_in_ms = 2

  Time to wait for operation to complete in milliseconds.

• int32 inter_op_thread_pool = 3

  The thread pool to use, if session_inter_op_thread_pool is configured. To use the caller thread set this to -1 - this uses the caller thread to execute Session::Run() and thus avoids a context switch. Using the caller thread to execute Session::Run() should be done ONLY for simple graphs, where the overhead of an additional context switch is comparable with the overhead of Session::Run().

• bool output_partition_graphs = 5

  Whether the partition graph(s) executed by the executor(s) should be outputted via RunMetadata.

• optional DebugOptions debug_options = 6

  EXPERIMENTAL. Options used to initialize DebuggerState, if enabled.

• bool report_tensor_allocations_upon_oom = 7

  When enabled, causes tensor allocation information to be included in the error message when the Run() call fails because the allocator ran out of memory (OOM). Enabling this option can slow down the Run() call.

• optional RunOptions.Experimental experimental = 8

Everything inside Experimental is subject to change and is not subject to API stability guarantees in https://www.tensorflow.org/guide/version_compat.

Used in: RunOptions

• int64 collective_graph_key = 1

  If non-zero, declares that this graph is going to use collective ops and must synchronize step_ids with any other graph with this same group_key value (in a distributed computation where tasks run disjoint graphs).

• bool use_run_handler_pool = 2

  If true, then operations (using the inter-op pool) across all session::run() calls will be centrally scheduled, optimizing for (median and tail) latency. Consider using this option for CPU-bound workloads like inference.

• optional Experimental.RunHandlerPoolOptions run_handler_pool_options = 3

Options for run handler thread pool.

Used in: Experimental

• int64 priority = 1

  Priority of the request. The run handler thread pool will schedule ops based on the priority number. The larger number means higher priority.

TODO(pbar) Turn this into a TraceOptions proto which allows tracing to be controlled in a more orthogonal manner?

Used in: RunOptions

• NO_TRACE = 0

• SOFTWARE_TRACE = 1

• HARDWARE_TRACE = 2

• FULL_TRACE = 3

Used in: VariableDef

• string full_name = 1

  Name of the full variable of which this is a slice.

• repeated int64 full_shape = 2

  Shape of the full variable.

• repeated int64 var_offset = 3

  Offset of this variable into the full variable.

• repeated int64 var_shape = 4

  Shape of this variable.

Used in: SavedObject

• int32 save_function = 2

  Node ids of concrete functions for saving and loading from a checkpoint.

• int32 restore_function = 3

A SavedAsset points to an asset in the MetaGraph. When bound to a function this object evaluates to a tensor with the absolute filename. Users should not depend on a particular part of the filename to remain stable (e.g. basename could be changed).

Used in: SavedObject

• int32 asset_file_def_index = 1

  Index into `MetaGraphDef.asset_file_def[]` that describes the Asset. Only the field `AssetFileDef.filename` is used. Other fields, such as `AssetFileDef.tensor_info`, MUST be ignored.

Used in: SavedObject

• string concrete_function_name = 1

  Identifies a SavedConcreteFunction.

• repeated string argument_keywords = 2

  A sequence of unique strings, one per Tensor argument.

• int64 allowed_positional_arguments = 3

  The prefix of `argument_keywords` which may be identified by position.

Stores low-level information about a concrete function. Referenced in either a SavedFunction or a SavedBareConcreteFunction.

Used in: SavedObjectGraph

• repeated int32 bound_inputs = 2

  Bound inputs to the function. The SavedObjects identified by the node ids given here are appended as extra inputs to the caller-supplied inputs. The only types of SavedObjects valid here are SavedVariable, SavedResource and SavedAsset.

• optional StructuredValue canonicalized_input_signature = 3

  Input in canonicalized form that was received to create this concrete function.

• optional StructuredValue output_signature = 4

  Output that was the return value of this function after replacing all Tensors with TensorSpecs. This can be an arbitrary nested function and will be used to reconstruct the full structure from pure tensors.

Used in: SavedObject

• string operation = 1

  An Operation name for a ConstantOp in this SavedObjectGraph's MetaGraph.

A function with multiple signatures, possibly with non-Tensor arguments.

Used in: SavedObject

• repeated string concrete_functions = 1

• optional FunctionSpec function_spec = 2

Used in: SavedObjectGraph

• repeated TrackableObjectGraph.TrackableObject.ObjectReference children = 1

  Objects which this object depends on: named edges in the dependency graph. Note: currently only valid if kind == "user_object".

• repeated TrackableObjectGraph.TrackableObject.SlotVariableReference slot_variables = 3

  Slot variables owned by this object. This describes the three-way (optimizer, variable, slot variable) relationship; none of the three depend on the others directly. Note: currently only valid if kind == "user_object".

• oneof kind

  • SavedUserObject user_object = 4

  • SavedAsset asset = 5

  • SavedFunction function = 6

  • SavedVariable variable = 7

  • SavedBareConcreteFunction bare_concrete_function = 8

  • SavedConstant constant = 9

  • SavedResource resource = 10

• map<string, SaveableObject> saveable_objects = 11

Used in: MetaGraphDef

• repeated SavedObject nodes = 1

  Flattened list of objects in the object graph. The position of the object in this list indicates its id. Nodes[0] is considered the root node.

• map<string, SavedConcreteFunction> concrete_functions = 2

  Information about captures and output structures in concrete functions. Referenced from SavedBareConcreteFunction and SavedFunction.

A SavedResource represents a TF object that holds state during its lifetime. An object of this type can have a reference to a: create_resource() and an initialize() function.

Used in: SavedObject

• string device = 1

  A device specification indicating a required placement for the resource creation function, e.g. "CPU". An empty string allows the user to select a device.

A SavedUserObject is an object (in the object-oriented language of the TensorFlow program) of some user- or framework-defined class other than those handled specifically by the other kinds of SavedObjects. This object cannot be evaluated as a tensor, and therefore cannot be bound to an input of a function.

Used in: SavedObject

• string identifier = 1

  Corresponds to a registration of the type to use in the loading program.

• optional VersionDef version = 2

  Version information from the producer of this SavedUserObject.

• string metadata = 3

  Initialization-related metadata.

Represents a Variable that is initialized by loading the contents from the checkpoint.

Used in: SavedObject

• DataType dtype = 1

• optional TensorShapeProto shape = 2

• bool trainable = 3

• VariableSynchronization synchronization = 4

• VariableAggregation aggregation = 5

• string name = 6

• string device = 7

Protocol buffer representing the configuration of a Saver.

Used in: MetaGraphDef

• string filename_tensor_name = 1

  The name of the tensor in which to specify the filename when saving or restoring a model checkpoint.

• string save_tensor_name = 2

  The operation to run when saving a model checkpoint.

• string restore_op_name = 3

  The operation to run when restoring a model checkpoint.

• int32 max_to_keep = 4

  Maximum number of checkpoints to keep. If 0, no checkpoints are deleted.

• bool sharded = 5

  Shard the save files, one per device that has Variable nodes.

• float keep_checkpoint_every_n_hours = 6

  How often to keep an additional checkpoint. If not specified, only the last "max_to_keep" checkpoints are kept; if specified, in addition to keeping the last "max_to_keep" checkpoints, an additional checkpoint will be kept for every n hours of training.

• SaverDef.CheckpointFormatVersion version = 7

A version number that identifies a different on-disk checkpoint format. Usually, each subclass of BaseSaverBuilder works with a particular version/format. However, it is possible that the same builder may be upgraded to support a newer checkpoint format in the future.

Used in: SaverDef

• LEGACY = 0

  Internal legacy format.

• V1 = 1

  Deprecated format: tf.Saver() which works with tensorflow::table::Table.

• V2 = 2

  Current format: more efficient.

Scalar summaries created by the `tensorboard.plugins.scalar.summary` module will include `SummaryMetadata` whose `plugin_data` field has as `content` a binary string that is the encoding of an `ScalarPluginData` proto.

• int32 version = 1

  Version `0` is the only supported version.

Used in: RewriterConfig

• repeated string enable_op = 1

  If present, only perform optimization for these ops.

Protocol buffer used for logging session state.

Used in: Event

• SessionLog.SessionStatus status = 1

• string checkpoint_path = 2

  This checkpoint_path contains both the path and filename.

• string msg = 3

Used in: SessionLog

• STATUS_UNSPECIFIED = 0

• START = 1

• STOP = 2

• CHECKPOINT = 3

Metadata about the session. This can be used by the runtime and the Ops for debugging, monitoring, etc. The (name, version) tuple is expected to be a unique identifier for sessions within the same process. NOTE: This is currently used and propagated only by the direct session.

Used in: ConfigProto.Experimental

• string name = 1

• int64 version = 2

  The version is optional. If set, needs to be >= 0.

SignatureDef defines the signature of a computation supported by a TensorFlow graph. For example, a model with two loss computations, sharing a single input, might have the following signature_def map. Note that across the two SignatureDefs "loss_A" and "loss_B", the input key, output key, and method_name are identical, and will be used by system(s) that implement or rely upon this particular loss method. The output tensor names differ, demonstrating how different outputs can exist for the same method. signature_def { key: "loss_A" value { inputs { key: "input" value { name: "input:0" dtype: DT_STRING tensor_shape: ... } } outputs { key: "loss_output" value { name: "loss_output_A:0" dtype: DT_FLOAT tensor_shape: ... } } } ... method_name: "some/package/compute_loss" } signature_def { key: "loss_B" value { inputs { key: "input" value { name: "input:0" dtype: DT_STRING tensor_shape: ... } } outputs { key: "loss_output" value { name: "loss_output_B:0" dtype: DT_FLOAT tensor_shape: ... } } } ... method_name: "some/package/compute_loss" }

Used in: MetaGraphDef

• map<string, TensorInfo> inputs = 1

  Named input parameters.

• map<string, TensorInfo> outputs = 2

  Named output parameters.

• string method_name = 3

  Extensible method_name information enabling third-party users to mark a SignatureDef as supporting a particular method. This enables producers and consumers of SignatureDefs, e.g. a model definition library and a serving library to have a clear hand-off regarding the semantics of a computation. Note that multiple SignatureDefs in a single MetaGraphDef may have the same method_name. This is commonly used to support multi-headed computation, where a single graph computation may return multiple results.

Used in: RunMetadata

• repeated DeviceStepStats dev_stats = 1

`StructuredValue` represents a dynamically typed value representing various data structures that are inspired by Python data structures typically used in TensorFlow functions as inputs and outputs. For example when saving a Layer there may be a `training` argument. If the user passes a boolean True/False, that switches between two concrete TensorFlow functions. In order to switch between them in the same way after loading the SavedModel, we need to represent "True" and "False". A more advanced example might be a function which takes a list of dictionaries mapping from strings to Tensors. In order to map from user-specified arguments `[{"a": tf.constant(1.)}, {"q": tf.constant(3.)}]` after load to the right saved TensorFlow function, we need to represent the nested structure and the strings, recording that we have a trace for anything matching `[{"a": tf.TensorSpec(None, tf.float32)}, {"q": tf.TensorSpec([], tf.float64)}]` as an example. Likewise functions may return nested structures of Tensors, for example returning a dictionary mapping from strings to Tensors. In order for the loaded function to return the same structure we need to serialize it. This is an ergonomic aid for working with loaded SavedModels, not a promise to serialize all possible function signatures. For example we do not expect to pickle generic Python objects, and ideally we'd stay language-agnostic.

Used in: DictValue, FunctionSpec, ListValue, PairValue, SavedConcreteFunction, TupleValue, TypeSpecProto

• oneof kind

  The kind of value.

  • NoneValue none_value = 1

    Represents None.

  • double float64_value = 11

    Represents a double-precision floating-point value (a Python `float`).

  • sint64 int64_value = 12

    Represents a signed integer value, limited to 64 bits. Larger values from Python's arbitrary-precision integers are unsupported.

  • string string_value = 13

    Represents a string of Unicode characters stored in a Python `str`. In Python 3, this is exactly what type `str` is. In Python 2, this is the UTF-8 encoding of the characters. For strings with ASCII characters only (as often used in TensorFlow code) there is effectively no difference between the language versions. The obsolescent `unicode` type of Python 2 is not supported here.

  • bool bool_value = 14

    Represents a boolean value.

  • TensorShapeProto tensor_shape_value = 31

    Represents a TensorShape.

  • DataType tensor_dtype_value = 32

    Represents an enum value for dtype.

  • TensorSpecProto tensor_spec_value = 33

    Represents a value for tf.TensorSpec.

  • TypeSpecProto type_spec_value = 34

    Represents a value for tf.TypeSpec.

  • BoundedTensorSpecProto bounded_tensor_spec_value = 35

    Represents a value for tf.BoundedTensorSpec.

  • ListValue list_value = 51

    Represents a list of `Value`.

  • TupleValue tuple_value = 52

    Represents a tuple of `Value`.

  • DictValue dict_value = 53

    Represents a dict `Value`.

  • NamedTupleValue named_tuple_value = 54

    Represents Python's namedtuple.

A Summary is a set of named values to be displayed by the visualizer. Summaries are produced regularly during training, as controlled by the "summary_interval_secs" attribute of the training operation. Summaries are also produced at the end of an evaluation.

Used in: Event

• repeated Summary.Value value = 1

  Set of values for the summary.

Used in: Value

• float sample_rate = 1

  Sample rate of the audio in Hz.

• int64 num_channels = 2

  Number of channels of audio.

• int64 length_frames = 3

  Length of the audio in frames (samples per channel).

• bytes encoded_audio_string = 4

  Encoded audio data and its associated RFC 2045 content type (e.g. "audio/wav").

• string content_type = 5

Used in: Value

• int32 height = 1

  Dimensions of the image.

• int32 width = 2

• int32 colorspace = 3

  Valid colorspace values are 1 - grayscale 2 - grayscale + alpha 3 - RGB 4 - RGBA 5 - DIGITAL_YUV 6 - BGRA

• bytes encoded_image_string = 4

  Image data in encoded format. All image formats supported by image_codec::CoderUtil can be stored here.

Used in: Summary

• string node_name = 7

  This field is deprecated and will not be set.

• string tag = 1

  Tag name for the data. Used by TensorBoard plugins to organize data. Tags are often organized by scope (which contains slashes to convey hierarchy). For example: foo/bar/0

• optional SummaryMetadata metadata = 9

  Contains metadata on the summary value such as which plugins may use it. Take note that many summary values may lack a metadata field. This is because the FileWriter only keeps a metadata object on the first summary value with a certain tag for each tag. TensorBoard then remembers which tags are associated with which plugins. This saves space.

• oneof value

  Value associated with the tag.

  • float simple_value = 2

  • bytes obsolete_old_style_histogram = 3

  • Image image = 4

  • HistogramProto histo = 5

  • Audio audio = 6

  • TensorProto tensor = 8

Metadata associated with a series of Summary data

• string type_hint = 1

  Hint on how plugins should process the data in this series. Supported values include "scalar", "histogram", "image", "audio"

A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.

Used in: Summary.Value, service.GetOrCreateBlobSequenceRequest, service.ScalarPointMetadata, service.StreamExperimentDataResponse, service.TensorTag, service.WriteScalarRequest.Tag, service.WriteTensorRequest.Tag

• optional SummaryMetadata.PluginData plugin_data = 1

  Data that associates a summary with a certain plugin.

• string display_name = 2

  Display name for viewing in TensorBoard.

• string summary_description = 3

  Longform readable description of the summary sequence. Markdown supported.

• DataClass data_class = 4

  Class of data stored in this time series. Required for compatibility with TensorBoard's generic data facilities (`DataProvider`, et al.). This value imposes constraints on the dtype and shape of the corresponding tensor values. See `DataClass` docs for details.

Used in: SummaryMetadata

• string plugin_name = 1

  The name of the plugin this data pertains to.

• bytes content = 2

  The content to store for the plugin. The best practice is for this to be a binary serialized protocol buffer.

For logging the metadata output for a single session.run() call.

Used in: Event

• string tag = 1

  Tag name associated with this metadata.

• bytes run_metadata = 2

  Byte-encoded version of the `RunMetadata` proto in order to allow lazy deserialization.

Defines a connection between two tensors in a `GraphDef`.

Used in: CallableOptions

• string from_tensor = 1

  A tensor name. The value of this tensor will be substituted for the tensor named in `to_tensor`.

• string to_tensor = 2

  A tensor name. The value of this tensor will be bound to the value of the tensor named in `from_tensor`.

Used in: NodeOutput

• DataType dtype = 1

  Data type of tensor elements

• optional TensorShapeProto shape = 2

  Shape of the tensor.

• optional AllocationDescription allocation_description = 4

  Information about the size and allocator used for the data

Information about a Tensor necessary for feeding or retrieval.

Used in: AssetFileDef, SignatureDef, TensorInfo.CompositeTensor

• oneof encoding

  • string name = 1

    For dense `Tensor`s, the name of the tensor in the graph.

  • TensorInfo.CooSparse coo_sparse = 4

    There are many possible encodings of sparse matrices (https://en.wikipedia.org/wiki/Sparse_matrix). Currently, TensorFlow uses only the COO encoding. This is supported and documented in the SparseTensor Python class.

  • TensorInfo.CompositeTensor composite_tensor = 5

    Generic encoding for CompositeTensors.

• DataType dtype = 2

• optional TensorShapeProto tensor_shape = 3

  The static shape should be recorded here, to the extent that it can be known in advance. In the case of a SparseTensor, this field describes the logical shape of the represented tensor (aka dense_shape).

Generic encoding for composite tensors.

Used in: TensorInfo

• optional TypeSpecProto type_spec = 1

  The serialized TypeSpec for the composite tensor.

• repeated TensorInfo components = 2

  A TensorInfo for each flattened component tensor.

For sparse tensors, The COO encoding stores a triple of values, indices, and shape.

Used in: TensorInfo

• string values_tensor_name = 1

  The shape of the values Tensor is [?]. Its dtype must be the dtype of the SparseTensor as a whole, given in the enclosing TensorInfo.

• string indices_tensor_name = 2

  The indices Tensor must have dtype int64 and shape [?, ?].

• string dense_shape_tensor_name = 3

  The dynamic logical shape represented by the SparseTensor is recorded in the Tensor referenced here. It must have dtype int64 and shape [?].

Protocol buffer representing a tensor.

Used in: AttrValue, AttrValue.ListValue, BoundedTensorSpecProto, Summary.Value, VariantTensorDataProto, service.StreamExperimentDataResponse.TensorPoints, service.TensorPoint

• DataType dtype = 1

• optional TensorShapeProto tensor_shape = 2

  Shape of the tensor. TODO(touts): sort out the 0-rank issues.

• int32 version_number = 3

  Version number. In version 0, if the "repeated xxx" representations contain only one element, that element is repeated to fill the shape. This makes it easy to represent a constant Tensor with a single value.

• bytes tensor_content = 4

  Serialized raw tensor content from either Tensor::AsProtoTensorContent or memcpy in tensorflow::grpc::EncodeTensorToByteBuffer. This representation can be used for all tensor types. The purpose of this representation is to reduce serialization overhead during RPC call by avoiding serialization of many repeated small items.

• repeated int32 half_val = 13

  DT_HALF, DT_BFLOAT16. Note that since protobuf has no int16 type, we'll have some pointless zero padding for each value here.

• repeated float float_val = 5

  DT_FLOAT.

• repeated double double_val = 6

  DT_DOUBLE.

• repeated int32 int_val = 7

  DT_INT32, DT_INT16, DT_INT8, DT_UINT8.

• repeated bytes string_val = 8

  DT_STRING

• repeated float scomplex_val = 9

  DT_COMPLEX64. scomplex_val(2*i) and scomplex_val(2*i+1) are real and imaginary parts of i-th single precision complex.

• repeated int64 int64_val = 10

  DT_INT64

• repeated bool bool_val = 11

  DT_BOOL

• repeated double dcomplex_val = 12

  DT_COMPLEX128. dcomplex_val(2*i) and dcomplex_val(2*i+1) are real and imaginary parts of i-th double precision complex.

• repeated ResourceHandleProto resource_handle_val = 14

  DT_RESOURCE

• repeated VariantTensorDataProto variant_val = 15

  DT_VARIANT

• repeated uint32 uint32_val = 16

  DT_UINT32

• repeated uint64 uint64_val = 17

  DT_UINT64

Dimensions of a tensor.

Used in: AttrValue, AttrValue.ListValue, BoundedTensorSpecProto, CostGraphDef.Node.OutputInfo, CppShapeInferenceResult, CppShapeInferenceResult.HandleShapeAndType, ResourceHandleProto.DtypeAndShape, SavedVariable, StructuredValue, TensorDescription, TensorInfo, TensorProto, TensorSpecProto

• repeated TensorShapeProto.Dim dim = 2

  Dimensions of the tensor, such as {"input", 30}, {"output", 40} for a 30 x 40 2D tensor. If an entry has size -1, this corresponds to a dimension of unknown size. The names are optional. The order of entries in "dim" matters: It indicates the layout of the values in the tensor in-memory representation. The first entry in "dim" is the outermost dimension used to layout the values, the last entry is the innermost dimension. This matches the in-memory layout of RowMajor Eigen tensors. If "dim.size()" > 0, "unknown_rank" must be false.

• bool unknown_rank = 3

  If true, the number of dimensions in the shape is unknown. If true, "dim.size()" must be 0.

One dimension of the tensor.

Used in: TensorShapeProto

• int64 size = 1

  Size of the tensor in that dimension. This value must be >= -1, but values of -1 are reserved for "unknown" shapes (values of -1 mean "unknown" dimension). Certain wrappers that work with TensorShapeProto may fail at runtime when deserializing a TensorShapeProto containing a dim value of -1.

• string name = 2

  Optional name of the tensor dimension.

A protobuf to represent tf.TensorSpec.

Used in: StructuredValue

• string name = 1

• optional TensorShapeProto shape = 2

• DataType dtype = 3

Text summaries created by the `tensorboard.plugins.text.summary` module will include `SummaryMetadata` whose `plugin_data` field has as `content` a binary string that is the encoding of an `TextPluginData` proto.

• int32 version = 1

  Version `0` is the only supported version.

Used in: ConfigProto

• int32 num_threads = 1

  The number of threads in the pool. 0 means the system picks a value based on where this option proto is used (see the declaration of the specific field for more info).

• string global_name = 2

  The global name of the threadpool. If empty, then the threadpool is made and used according to the scope it's in - e.g., for a session threadpool, it is used by that session only. If non-empty, then: - a global threadpool associated with this name is looked up or created. This allows, for example, sharing one threadpool across many sessions (e.g., like the default behavior, if inter_op_parallelism_threads is not configured), but still partitioning into a large and small pool. - if the threadpool for this global_name already exists, then it is an error if the existing pool was created using a different num_threads value as is specified on this call. - threadpools created this way are never garbage collected.

• repeated TrackableObjectGraph.TrackableObject nodes = 1

Used in: TrackableObjectGraph

• repeated TrackableObject.ObjectReference children = 1

  Objects which this object depends on.

• repeated TrackableObject.SerializedTensor attributes = 2

  Serialized data specific to this object.

• repeated TrackableObject.SlotVariableReference slot_variables = 3

  Slot variables owned by this object.

Used in: SavedObject, TrackableObject

• int32 node_id = 1

  An index into `TrackableObjectGraph.nodes`, indicating the object being referenced.

• string local_name = 2

  A user-provided name for the edge.

Used in: TrackableObject

• string name = 1

  A name for the Tensor. Simple variables have only one `SerializedTensor` named "VARIABLE_VALUE" by convention. This value may be restored on object creation as an optimization.

• string full_name = 2

  The full name of the variable/tensor, if applicable. Used to allow name-based loading of checkpoints which were saved using an object-based API. Should match the checkpoint key which would have been assigned by tf.train.Saver.

• string checkpoint_key = 3

  The generated name of the Tensor in the checkpoint.

• bool optional_restore = 4

  Whether checkpoints should be considered as matching even without this value restored. Used for non-critical values which don't affect the TensorFlow graph, such as layer configurations.

Used in: SavedObject, TrackableObject

• int32 original_variable_node_id = 1

  An index into `TrackableObjectGraph.nodes`, indicating the variable object this slot was created for.

• string slot_name = 2

  The name of the slot (e.g. "m"/"v").

• int32 slot_variable_node_id = 3

  An index into `TrackableObjectGraph.nodes`, indicating the `Object` with the value of the slot variable.

Used in: ExecTime, ProfileNode

• repeated int64 int64_values = 1

Represents a Python tuple.

Used in: StructuredValue

• repeated StructuredValue values = 1

Represents a tf.TypeSpec

Used in: StructuredValue, TensorInfo.CompositeTensor

• TypeSpecProto.TypeSpecClass type_spec_class = 1

• optional StructuredValue type_state = 2

  The value returned by TypeSpec._serialize().

• string type_spec_class_name = 3

  This is currently redundant with the type_spec_class enum, and is only used for error reporting. In particular, if you use an older binary to load a newer model, and the model uses a TypeSpecClass that the older binary doesn't support, then this lets us display a useful error message.

Used in: TypeSpecProto

• UNKNOWN = 0

• SPARSE_TENSOR_SPEC = 1

  tf.SparseTensorSpec

• INDEXED_SLICES_SPEC = 2

  tf.IndexedSlicesSpec

• RAGGED_TENSOR_SPEC = 3

  tf.RaggedTensorSpec

• TENSOR_ARRAY_SPEC = 4

  tf.TensorArraySpec

• DATA_DATASET_SPEC = 5

  tf.data.DatasetSpec

• DATA_ITERATOR_SPEC = 6

  IteratorSpec from data/ops/iterator_ops.py

• OPTIONAL_SPEC = 7

  tf.OptionalSpec

• PER_REPLICA_SPEC = 8

  PerReplicaSpec from distribute/values.py

• VARIABLE_SPEC = 9

  tf.VariableSpec

• ROW_PARTITION_SPEC = 10

  RowPartitionSpec from ragged/row_partition.py

• NDARRAY_SPEC = 11

  TF Numpy NDarray spec

Indicates how a distributed variable will be aggregated.

Used in: SavedVariable, VariableDef

• VARIABLE_AGGREGATION_NONE = 0

  `NONE`: This is the default, giving an error if you use a variable-update operation with multiple replicas.

• VARIABLE_AGGREGATION_SUM = 1

  `SUM`: Add the updates across replicas.

• VARIABLE_AGGREGATION_MEAN = 2

  `MEAN`: Take the arithmetic mean ("average") of the updates across replicas.

• VARIABLE_AGGREGATION_ONLY_FIRST_REPLICA = 3

  `ONLY_FIRST_REPLICA`: This is for when every replica is performing the same update, but we only want to perform the update once. Used, e.g., for the global step counter.

Protocol buffer representing a Variable.

• string variable_name = 1

  Name of the variable tensor.

• string initial_value_name = 6

  Name of the tensor holding the variable's initial value.

• string initializer_name = 2

  Name of the initializer op.

• string snapshot_name = 3

  Name of the snapshot tensor.

• optional SaveSliceInfoDef save_slice_info_def = 4

  Support for saving variables as slices of a larger variable.

• bool is_resource = 5

  Whether to represent this as a ResourceVariable.

• bool trainable = 7

  Whether this variable should be trained.

• VariableSynchronization synchronization = 8

  Indicates when a distributed variable will be synced.

• VariableAggregation aggregation = 9

  Indicates how a distributed variable will be aggregated.

Indicates when a distributed variable will be synced.

Used in: SavedVariable, VariableDef

• VARIABLE_SYNCHRONIZATION_AUTO = 0

  `AUTO`: Indicates that the synchronization will be determined by the current `DistributionStrategy` (eg. With `MirroredStrategy` this would be `ON_WRITE`).

• VARIABLE_SYNCHRONIZATION_NONE = 1

  `NONE`: Indicates that there will only be one copy of the variable, so there is no need to sync.

• VARIABLE_SYNCHRONIZATION_ON_WRITE = 2

  `ON_WRITE`: Indicates that the variable will be updated across devices every time it is written.

• VARIABLE_SYNCHRONIZATION_ON_READ = 3

  `ON_READ`: Indicates that the variable will be aggregated across devices when it is read (eg. when checkpointing or when evaluating an op that uses the variable).

Protocol buffer representing the serialization format of DT_VARIANT tensors.

Used in: TensorProto

• string type_name = 1

  Name of the type of objects being serialized.

• bytes metadata = 2

  Portions of the object that are not Tensors.

• repeated TensorProto tensors = 3

  Tensors contained within objects being serialized.

The config for graph verifiers.

Used in: RewriterConfig

• int64 verification_timeout_in_ms = 1

  Deadline for completion of all verification i.e. all the Toggle ON verifiers must complete execution within this time.

• VerifierConfig.Toggle structure_verifier = 2

  Perform structural validation on a tensorflow graph. Default is OFF.

Used in: VerifierConfig

• DEFAULT = 0

• ON = 1

• OFF = 2

Version information for a piece of serialized data There are different types of versions for each type of data (GraphDef, etc.), but they all have the same common shape described here. Each consumer has "consumer" and "min_producer" versions (specified elsewhere). A consumer is allowed to consume this data if producer >= min_producer consumer >= min_consumer consumer not in bad_consumers

Used in: GraphDef, SavedUserObject

• int32 producer = 1

  The version of the code that produced this data.

• int32 min_consumer = 2

  Any consumer below this version is not allowed to consume this data.

• repeated int32 bad_consumers = 3

  Specific consumer versions which are disallowed (e.g. due to bugs).

Used in: WorkerHeartbeatRequest

• int64 timeout_ms = 1

Current health status of a worker.

Used in: WorkerHeartbeatResponse

• OK = 0

  By default a worker is healthy.

• RECEIVED_SHUTDOWN_SIGNAL = 1

• INTERNAL_ERROR = 2

• SHUTTING_DOWN = 3

  Worker has been instructed to shutdown after a timeout.

• WorkerShutdownMode shutdown_mode = 1

• optional WatchdogConfig watchdog_config = 2

• optional RequestedExitCode exit_code = 3

• WorkerHealth health_status = 1

• repeated Event worker_log = 2

• string hostname = 3

Indicates the behavior of the worker when an internal error or shutdown signal is received.

Used in: WorkerHeartbeatRequest

• DEFAULT = 0

• NOT_CONFIGURED = 1

• WAIT_FOR_COORDINATOR = 2

• SHUTDOWN_AFTER_TIMEOUT = 3