ApiDef

public final class ApiDef 

 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.
Protobuf type tensorflow.ApiDef

Nested Classes

class ApiDef.Arg Protobuf type tensorflow.ApiDef.Arg  
interface ApiDef.ArgOrBuilder  
class ApiDef.Attr 
 Description of the graph-construction-time configuration of this
 Op. 
interface ApiDef.AttrOrBuilder  
class ApiDef.Builder 
 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. 
class ApiDef.Endpoint 
 If you specify any endpoint, this will replace all of the
 inherited endpoints. 
interface ApiDef.EndpointOrBuilder  
enum ApiDef.Visibility Protobuf enum tensorflow.ApiDef.Visibility  

Constants

int ARG_ORDER_FIELD_NUMBER
int ATTR_FIELD_NUMBER
int DEPRECATION_MESSAGE_FIELD_NUMBER
int DEPRECATION_VERSION_FIELD_NUMBER
int DESCRIPTION_FIELD_NUMBER
int DESCRIPTION_PREFIX_FIELD_NUMBER
int DESCRIPTION_SUFFIX_FIELD_NUMBER
int ENDPOINT_FIELD_NUMBER
int GRAPH_OP_NAME_FIELD_NUMBER
int IN_ARG_FIELD_NUMBER
int OUT_ARG_FIELD_NUMBER
int SUMMARY_FIELD_NUMBER
int VISIBILITY_FIELD_NUMBER

Public Methods

boolean
equals(Object obj)
String
getArgOrder(int index) 
 List of original in_arg names to specify new argument order.
com.google.protobuf.ByteString
getArgOrderBytes(int index) 
 List of original in_arg names to specify new argument order.
int
getArgOrderCount() 
 List of original in_arg names to specify new argument order.
com.google.protobuf.ProtocolStringList
getArgOrderList() 
 List of original in_arg names to specify new argument order.
ApiDef.Attr
getAttr(int index)
repeated .tensorflow.ApiDef.Attr attr = 6;
int
getAttrCount()
repeated .tensorflow.ApiDef.Attr attr = 6;
List<ApiDef.Attr>
getAttrList()
repeated .tensorflow.ApiDef.Attr attr = 6;
ApiDef.AttrOrBuilder
getAttrOrBuilder(int index)
repeated .tensorflow.ApiDef.Attr attr = 6;
List<? extends ApiDef.AttrOrBuilder>
getAttrOrBuilderList()
repeated .tensorflow.ApiDef.Attr attr = 6;
static ApiDef
getDefaultInstance()
ApiDef
getDefaultInstanceForType()
String
getDeprecationMessage() 
 If this op is deprecated, set deprecation message to the message
 that should be logged when this op is used.
com.google.protobuf.ByteString
getDeprecationMessageBytes() 
 If this op is deprecated, set deprecation message to the message
 that should be logged when this op is used.
int
getDeprecationVersion() 
 Major version when the op will be deleted.
String
getDescription() 
 Additional, longer human-readable description of what the Op does.
com.google.protobuf.ByteString
getDescriptionBytes() 
 Additional, longer human-readable description of what the Op does.
String
getDescriptionPrefix() 
 Modify an existing/inherited description by adding text to the beginning
 or end.
com.google.protobuf.ByteString
getDescriptionPrefixBytes() 
 Modify an existing/inherited description by adding text to the beginning
 or end.
String
getDescriptionSuffix()
string description_suffix = 10;
com.google.protobuf.ByteString
getDescriptionSuffixBytes()
string description_suffix = 10;
final static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
ApiDef.Endpoint
getEndpoint(int index)
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
int
getEndpointCount()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
List<ApiDef.Endpoint>
getEndpointList()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
ApiDef.EndpointOrBuilder
getEndpointOrBuilder(int index)
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
List<? extends ApiDef.EndpointOrBuilder>
getEndpointOrBuilderList()
repeated .tensorflow.ApiDef.Endpoint endpoint = 3;
String
getGraphOpName() 
 Name of the op (in the OpDef) to specify the API for.
com.google.protobuf.ByteString
getGraphOpNameBytes() 
 Name of the op (in the OpDef) to specify the API for.
ApiDef.Arg
getInArg(int index)
repeated .tensorflow.ApiDef.Arg in_arg = 4;
int
getInArgCount()
repeated .tensorflow.ApiDef.Arg in_arg = 4;
List<ApiDef.Arg>
getInArgList()
repeated .tensorflow.ApiDef.Arg in_arg = 4;
ApiDef.ArgOrBuilder
getInArgOrBuilder(int index)
repeated .tensorflow.ApiDef.Arg in_arg = 4;
List<? extends ApiDef.ArgOrBuilder>
getInArgOrBuilderList()
repeated .tensorflow.ApiDef.Arg in_arg = 4;
ApiDef.Arg
getOutArg(int index)
repeated .tensorflow.ApiDef.Arg out_arg = 5;
int
getOutArgCount()
repeated .tensorflow.ApiDef.Arg out_arg = 5;
List<ApiDef.Arg>
getOutArgList()
repeated .tensorflow.ApiDef.Arg out_arg = 5;
ApiDef.ArgOrBuilder
getOutArgOrBuilder(int index)
repeated .tensorflow.ApiDef.Arg out_arg = 5;
List<? extends ApiDef.ArgOrBuilder>
getOutArgOrBuilderList()
repeated .tensorflow.ApiDef.Arg out_arg = 5;
getParserForType()
int
getSerializedSize()
String
getSummary() 
 One-line human-readable description of what the Op does.
com.google.protobuf.ByteString
getSummaryBytes() 
 One-line human-readable description of what the Op does.
final com.google.protobuf.UnknownFieldSet
getUnknownFields()
ApiDef.Visibility
getVisibility()
.tensorflow.ApiDef.Visibility visibility = 2;
int
getVisibilityValue()
.tensorflow.ApiDef.Visibility visibility = 2;
int
hashCode()
final boolean
isInitialized()
static ApiDef.Builder
newBuilder()
static ApiDef.Builder
newBuilder(ApiDef prototype)
ApiDef.Builder
newBuilderForType()
static ApiDef
parseDelimitedFrom(InputStream input)
static ApiDef
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ApiDef
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ApiDef
parseFrom(com.google.protobuf.CodedInputStream input)
static ApiDef
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ApiDef
parseFrom(ByteBuffer data)
static ApiDef
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ApiDef
parseFrom(com.google.protobuf.ByteString data)
static ApiDef
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ApiDef
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static
parser()
ApiDef.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)

Inherited Methods

Constants

public static final int ARG_ORDER_FIELD_NUMBER

Constant Value: 11

public static final int ATTR_FIELD_NUMBER

Constant Value: 6

public static final int DEPRECATION_MESSAGE_FIELD_NUMBER

Constant Value: 12

public static final int DEPRECATION_VERSION_FIELD_NUMBER

Constant Value: 13

public static final int DESCRIPTION_FIELD_NUMBER

Constant Value: 8

public static final int DESCRIPTION_PREFIX_FIELD_NUMBER

Constant Value: 9

public static final int DESCRIPTION_SUFFIX_FIELD_NUMBER

Constant Value: 10

public static final int ENDPOINT_FIELD_NUMBER

Constant Value: 3

public static final int GRAPH_OP_NAME_FIELD_NUMBER

Constant Value: 1

public static final int IN_ARG_FIELD_NUMBER

Constant Value: 4

public static final int OUT_ARG_FIELD_NUMBER

Constant Value: 5

public static final int SUMMARY_FIELD_NUMBER

Constant Value: 7

public static final int VISIBILITY_FIELD_NUMBER

Constant Value: 2

Public Methods

public boolean equals (Object obj)

public String getArgOrder (int index) 

 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 string arg_order = 11;

public com.google.protobuf.ByteString getArgOrderBytes (int index) 

 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 string arg_order = 11;

public int getArgOrderCount () 

 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 string arg_order = 11;

public com.google.protobuf.ProtocolStringList getArgOrderList () 

 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 string arg_order = 11;

public ApiDef.Attr getAttr (int index)

repeated .tensorflow.ApiDef.Attr attr = 6;

public int getAttrCount ()

repeated .tensorflow.ApiDef.Attr attr = 6;

public List<ApiDef.Attr> getAttrList ()

repeated .tensorflow.ApiDef.Attr attr = 6;

public ApiDef.AttrOrBuilder getAttrOrBuilder (int index)

repeated .tensorflow.ApiDef.Attr attr = 6;

public List<? extends ApiDef.AttrOrBuilder> getAttrOrBuilderList ()

repeated .tensorflow.ApiDef.Attr attr = 6;

public static ApiDef getDefaultInstance ()

public ApiDef getDefaultInstanceForType ()

public String getDeprecationMessage () 

 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.
string deprecation_message = 12;

public com.google.protobuf.ByteString getDeprecationMessageBytes () 

 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.
string deprecation_message = 12;

public int getDeprecationVersion () 

 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.
int32 deprecation_version = 13;

public String getDescription () 

 Additional, longer human-readable description of what the Op does.
string description = 8;

public com.google.protobuf.ByteString getDescriptionBytes () 

 Additional, longer human-readable description of what the Op does.
string description = 8;

public String getDescriptionPrefix () 

 Modify an existing/inherited description by adding text to the beginning
 or end.
string description_prefix = 9;

public com.google.protobuf.ByteString getDescriptionPrefixBytes () 

 Modify an existing/inherited description by adding text to the beginning
 or end.
string description_prefix = 9;

public String getDescriptionSuffix ()

string description_suffix = 10;

public com.google.protobuf.ByteString getDescriptionSuffixBytes ()

string description_suffix = 10;

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()

public ApiDef.Endpoint getEndpoint (int index)

repeated .tensorflow.ApiDef.Endpoint endpoint = 3;

public int getEndpointCount ()

repeated .tensorflow.ApiDef.Endpoint endpoint = 3;

public List<ApiDef.Endpoint> getEndpointList ()

repeated .tensorflow.ApiDef.Endpoint endpoint = 3;

public ApiDef.EndpointOrBuilder getEndpointOrBuilder (int index)

repeated .tensorflow.ApiDef.Endpoint endpoint = 3;

public List<? extends ApiDef.EndpointOrBuilder> getEndpointOrBuilderList ()

repeated .tensorflow.ApiDef.Endpoint endpoint = 3;

public String getGraphOpName () 

 Name of the op (in the OpDef) to specify the API for.
string graph_op_name = 1;

public com.google.protobuf.ByteString getGraphOpNameBytes () 

 Name of the op (in the OpDef) to specify the API for.
string graph_op_name = 1;

public ApiDef.Arg getInArg (int index)

repeated .tensorflow.ApiDef.Arg in_arg = 4;

public int getInArgCount ()

repeated .tensorflow.ApiDef.Arg in_arg = 4;

public List<ApiDef.Arg> getInArgList ()

repeated .tensorflow.ApiDef.Arg in_arg = 4;

public ApiDef.ArgOrBuilder getInArgOrBuilder (int index)

repeated .tensorflow.ApiDef.Arg in_arg = 4;

public List<? extends ApiDef.ArgOrBuilder> getInArgOrBuilderList ()

repeated .tensorflow.ApiDef.Arg in_arg = 4;

public ApiDef.Arg getOutArg (int index)

repeated .tensorflow.ApiDef.Arg out_arg = 5;

public int getOutArgCount ()

repeated .tensorflow.ApiDef.Arg out_arg = 5;

public List<ApiDef.Arg> getOutArgList ()

repeated .tensorflow.ApiDef.Arg out_arg = 5;

public ApiDef.ArgOrBuilder getOutArgOrBuilder (int index)

repeated .tensorflow.ApiDef.Arg out_arg = 5;

public List<? extends ApiDef.ArgOrBuilder> getOutArgOrBuilderList ()

repeated .tensorflow.ApiDef.Arg out_arg = 5;

public getParserForType ()

public int getSerializedSize ()

public String getSummary () 

 One-line human-readable description of what the Op does.
string summary = 7;

public com.google.protobuf.ByteString getSummaryBytes () 

 One-line human-readable description of what the Op does.
string summary = 7;

public final com.google.protobuf.UnknownFieldSet getUnknownFields ()

public ApiDef.Visibility getVisibility ()

.tensorflow.ApiDef.Visibility visibility = 2;

public int getVisibilityValue ()

.tensorflow.ApiDef.Visibility visibility = 2;

public int hashCode ()

public final boolean isInitialized ()

public static ApiDef.Builder newBuilder ()

public static ApiDef.Builder newBuilder (ApiDef prototype)

public ApiDef.Builder newBuilderForType ()

public static ApiDef parseDelimitedFrom (InputStream input)

Throws
IOException

public static ApiDef parseDelimitedFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static ApiDef parseFrom (ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static ApiDef parseFrom (com.google.protobuf.CodedInputStream input)

Throws
IOException

public static ApiDef parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static ApiDef parseFrom (ByteBuffer data)

Throws
InvalidProtocolBufferException

public static ApiDef parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static ApiDef parseFrom (com.google.protobuf.ByteString data)

Throws
InvalidProtocolBufferException

public static ApiDef parseFrom (InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
IOException

public static ApiDef parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

Throws
InvalidProtocolBufferException

public static parser ()

public ApiDef.Builder toBuilder ()

public void writeTo (com.google.protobuf.CodedOutputStream output)

Throws
IOException