Packages

final case class ApiDef(graphOpName: String = "", deprecationMessage: String = "", deprecationVersion: Int = 0, visibility: Visibility = ..., endpoint: Seq[Endpoint] = _root_.scala.Seq.empty, inArg: Seq[Arg] = _root_.scala.Seq.empty, outArg: Seq[Arg] = _root_.scala.Seq.empty, argOrder: Seq[String] = _root_.scala.Seq.empty, attr: Seq[Attr] = _root_.scala.Seq.empty, summary: String = "", description: String = "", descriptionPrefix: String = "", descriptionSuffix: String = "", unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ApiDef] with Product with Serializable

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.

graphOpName

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

deprecationMessage

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.

deprecationVersion

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.

argOrder

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.

summary

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

description

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

descriptionPrefix

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

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[ApiDef], GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApiDef
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Serializable
  6. Product
  7. Equals
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ApiDef(graphOpName: String = "", deprecationMessage: String = "", deprecationVersion: Int = 0, visibility: Visibility = ..., endpoint: Seq[Endpoint] = _root_.scala.Seq.empty, inArg: Seq[Arg] = _root_.scala.Seq.empty, outArg: Seq[Arg] = _root_.scala.Seq.empty, argOrder: Seq[String] = _root_.scala.Seq.empty, attr: Seq[Attr] = _root_.scala.Seq.empty, summary: String = "", description: String = "", descriptionPrefix: String = "", descriptionSuffix: String = "", unknownFields: UnknownFieldSet = ...)

    graphOpName

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

    deprecationMessage

    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.

    deprecationVersion

    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.

    argOrder

    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.

    summary

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

    description

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

    descriptionPrefix

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllArgOrder(__vs: Iterable[String]): ApiDef
  5. def addAllAttr(__vs: Iterable[Attr]): ApiDef
  6. def addAllEndpoint(__vs: Iterable[Endpoint]): ApiDef
  7. def addAllInArg(__vs: Iterable[Arg]): ApiDef
  8. def addAllOutArg(__vs: Iterable[Arg]): ApiDef
  9. def addArgOrder(__vs: String*): ApiDef
  10. def addAttr(__vs: Attr*): ApiDef
  11. def addEndpoint(__vs: Endpoint*): ApiDef
  12. def addInArg(__vs: Arg*): ApiDef
  13. def addOutArg(__vs: Arg*): ApiDef
  14. val argOrder: Seq[String]
  15. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  16. val attr: Seq[Attr]
  17. def clearArgOrder: ApiDef
  18. def clearAttr: ApiDef
  19. def clearEndpoint: ApiDef
  20. def clearInArg: ApiDef
  21. def clearOutArg: ApiDef
  22. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  23. def companion: ApiDef.type
    Definition Classes
    ApiDef → GeneratedMessage
  24. val deprecationMessage: String
  25. val deprecationVersion: Int
  26. val description: String
  27. val descriptionPrefix: String
  28. val descriptionSuffix: String
  29. def discardUnknownFields: ApiDef
  30. val endpoint: Seq[Endpoint]
  31. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ApiDef → GeneratedMessage
  34. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ApiDef → GeneratedMessage
  35. val graphOpName: String
  36. val inArg: Seq[Arg]
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. val outArg: Seq[Arg]
  42. def serializedSize: Int
    Definition Classes
    ApiDef → GeneratedMessage
  43. val summary: String
  44. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  45. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  46. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  47. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  48. def toProtoString: String
    Definition Classes
    ApiDef → GeneratedMessage
  49. val unknownFields: UnknownFieldSet
  50. def update(ms: (Lens[ApiDef, ApiDef]) ⇒ Mutation[ApiDef]*): ApiDef
    Definition Classes
    Updatable
  51. val visibility: Visibility
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. def withArgOrder(__v: Seq[String]): ApiDef
  56. def withAttr(__v: Seq[Attr]): ApiDef
  57. def withDeprecationMessage(__v: String): ApiDef
  58. def withDeprecationVersion(__v: Int): ApiDef
  59. def withDescription(__v: String): ApiDef
  60. def withDescriptionPrefix(__v: String): ApiDef
  61. def withDescriptionSuffix(__v: String): ApiDef
  62. def withEndpoint(__v: Seq[Endpoint]): ApiDef
  63. def withGraphOpName(__v: String): ApiDef
  64. def withInArg(__v: Seq[Arg]): ApiDef
  65. def withOutArg(__v: Seq[Arg]): ApiDef
  66. def withSummary(__v: String): ApiDef
  67. def withUnknownFields(__v: UnknownFieldSet): ApiDef
  68. def withVisibility(__v: Visibility): ApiDef
  69. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  70. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ApiDef → GeneratedMessage
  71. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Updatable[ApiDef]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped