Struct tfrecord::protos::ApiDef

pub struct ApiDef {
    pub graph_op_name: String,
    pub deprecation_message: String,
    pub deprecation_version: i32,
    pub visibility: i32,
    pub endpoint: Vec<Endpoint>,
    pub in_arg: Vec<Arg>,
    pub out_arg: Vec<Arg>,
    pub arg_order: Vec<String>,
    pub attr: Vec<Attr>,
    pub summary: String,
    pub description: String,
    pub description_prefix: String,
    pub description_suffix: String,
}

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.

Fields

graph_op_name: String

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

deprecation_message: String

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.

deprecation_version: i32

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.

visibility: i32

endpoint: Vec<Endpoint>

in_arg: Vec<Arg>

out_arg: Vec<Arg>

arg_order: Vec<String>

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.

attr: Vec<Attr>

summary: String

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

description: String

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

description_prefix: String

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

description_suffix: String

Implementations

impl ApiDef

pub fn visibility(&self) -> Visibility

Returns the enum value of visibility, or the default if the field is set to an invalid enum value.

pub fn set_visibility(&mut self, value: Visibility)

Sets visibility to the provided enum value.

Trait Implementations

impl Clone for ApiDef

fn clone(&self) -> ApiDef

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiDef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApiDef

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApiDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Message for ApiDef

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ApiDef> for ApiDef

fn eq(&self, other: &ApiDef) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ApiDef) -> bool

This method tests for !=.

impl Serialize for ApiDef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiDef