final case class ModelProto(irVersion: Option[Long] = _root_.scala.None, opsetImport: Seq[OperatorSetIdProto] = _root_.scala.Seq.empty, producerName: Option[String] = _root_.scala.None, producerVersion: Option[String] = _root_.scala.None, domain: Option[String] = _root_.scala.None, modelVersion: Option[Long] = _root_.scala.None, docString: Option[String] = _root_.scala.None, graph: Option[GraphProto] = _root_.scala.None, metadataProps: Seq[StringStringEntryProto] = _root_.scala.Seq.empty, trainingInfo: Seq[TrainingInfoProto] = _root_.scala.Seq.empty, functions: Seq[FunctionProto] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[ModelProto] with Product with Serializable

Models

ModelProto is a top-level file/container format for bundling a ML model and associating its computation graph with metadata.

The semantics of the model are described by the associated GraphProto's.

irVersion

The version of the IR this model targets. See Version enum above. This field MUST be present.

opsetImport

The OperatorSets this model relies on. All ModelProtos MUST have at least one entry that specifies which version of the ONNX OperatorSet is being imported. All nodes in the ModelProto's graph will bind against the operator with the same-domain/same-op_type operator with the HIGHEST version in the referenced operator sets.

producerName

The name of the framework or tool used to generate this model. This field SHOULD be present to indicate which implementation/tool/framework emitted the model.

producerVersion

The version of the framework or tool used to generate this model. This field SHOULD be present to indicate which implementation/tool/framework emitted the model.

domain

Domain name of the model. We use reverse domain names as name space indicators. For example: com.facebook.fair or com.microsoft.cognitiveservices Together with model_version and GraphProto.name, this forms the unique identity of the graph.

modelVersion

The version of the graph encoded. See Version enum below.

docString

A human-readable documentation for this model. Markdown is allowed.

graph

The parameterized graph that is evaluated to execute the model.

metadataProps

Named metadata values; keys should be distinct.

trainingInfo

Training-specific information. Sequentially executing all stored TrainingInfoProto.algorithms and assigning their outputs following the corresponding TrainingInfoProto.update_bindings is one training iteration. Similarly, to initialize the model (as if training hasn't happened), the user should sequentially execute all stored TrainingInfoProto.initializations and assigns their outputs using TrainingInfoProto.initialization_bindings. If this field is empty, the training behavior of the model is undefined.

functions

A list of function protos local to the model. Name of the function "FunctionProto.name" should be unique within the domain "FunctionProto.domain". In case of any conflicts the behavior (whether the model local functions are given higher priority, or standard opserator sets are given higher priotity or this is treated as error) is defined by the runtimes. The operator sets imported by FunctionProto should be compatible with the ones imported by ModelProto and other model local FunctionProtos. Example, if same operator set say 'A' is imported by a FunctionProto and ModelProto or by 2 FunctionProtos then versions for the operator set may be different but, the operator schema returned for op_type, domain, version combination for both the versions should be same for every node in the function body. One FunctionProto can reference other FunctionProto in the model, however, recursive reference is not allowed.

Annotations
@SerialVersionUID()
Linear Supertypes
Updatable[ModelProto], GeneratedMessage, Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ModelProto
  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 ModelProto(irVersion: Option[Long] = _root_.scala.None, opsetImport: Seq[OperatorSetIdProto] = _root_.scala.Seq.empty, producerName: Option[String] = _root_.scala.None, producerVersion: Option[String] = _root_.scala.None, domain: Option[String] = _root_.scala.None, modelVersion: Option[Long] = _root_.scala.None, docString: Option[String] = _root_.scala.None, graph: Option[GraphProto] = _root_.scala.None, metadataProps: Seq[StringStringEntryProto] = _root_.scala.Seq.empty, trainingInfo: Seq[TrainingInfoProto] = _root_.scala.Seq.empty, functions: Seq[FunctionProto] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...)

    irVersion

    The version of the IR this model targets. See Version enum above. This field MUST be present.

    opsetImport

    The OperatorSets this model relies on. All ModelProtos MUST have at least one entry that specifies which version of the ONNX OperatorSet is being imported. All nodes in the ModelProto's graph will bind against the operator with the same-domain/same-op_type operator with the HIGHEST version in the referenced operator sets.

    producerName

    The name of the framework or tool used to generate this model. This field SHOULD be present to indicate which implementation/tool/framework emitted the model.

    producerVersion

    The version of the framework or tool used to generate this model. This field SHOULD be present to indicate which implementation/tool/framework emitted the model.

    domain

    Domain name of the model. We use reverse domain names as name space indicators. For example: com.facebook.fair or com.microsoft.cognitiveservices Together with model_version and GraphProto.name, this forms the unique identity of the graph.

    modelVersion

    The version of the graph encoded. See Version enum below.

    docString

    A human-readable documentation for this model. Markdown is allowed.

    graph

    The parameterized graph that is evaluated to execute the model.

    metadataProps

    Named metadata values; keys should be distinct.

    trainingInfo

    Training-specific information. Sequentially executing all stored TrainingInfoProto.algorithms and assigning their outputs following the corresponding TrainingInfoProto.update_bindings is one training iteration. Similarly, to initialize the model (as if training hasn't happened), the user should sequentially execute all stored TrainingInfoProto.initializations and assigns their outputs using TrainingInfoProto.initialization_bindings. If this field is empty, the training behavior of the model is undefined.

    functions

    A list of function protos local to the model. Name of the function "FunctionProto.name" should be unique within the domain "FunctionProto.domain". In case of any conflicts the behavior (whether the model local functions are given higher priority, or standard opserator sets are given higher priotity or this is treated as error) is defined by the runtimes. The operator sets imported by FunctionProto should be compatible with the ones imported by ModelProto and other model local FunctionProtos. Example, if same operator set say 'A' is imported by a FunctionProto and ModelProto or by 2 FunctionProtos then versions for the operator set may be different but, the operator schema returned for op_type, domain, version combination for both the versions should be same for every node in the function body. One FunctionProto can reference other FunctionProto in the model, however, recursive reference is not allowed.

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 addAllFunctions(__vs: Iterable[FunctionProto]): ModelProto
  5. def addAllMetadataProps(__vs: Iterable[StringStringEntryProto]): ModelProto
  6. def addAllOpsetImport(__vs: Iterable[OperatorSetIdProto]): ModelProto
  7. def addAllTrainingInfo(__vs: Iterable[TrainingInfoProto]): ModelProto
  8. def addFunctions(__vs: FunctionProto*): ModelProto
  9. def addMetadataProps(__vs: StringStringEntryProto*): ModelProto
  10. def addOpsetImport(__vs: OperatorSetIdProto*): ModelProto
  11. def addTrainingInfo(__vs: TrainingInfoProto*): ModelProto
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clearDocString: ModelProto
  14. def clearDomain: ModelProto
  15. def clearFunctions: ModelProto
  16. def clearGraph: ModelProto
  17. def clearIrVersion: ModelProto
  18. def clearMetadataProps: ModelProto
  19. def clearModelVersion: ModelProto
  20. def clearOpsetImport: ModelProto
  21. def clearProducerName: ModelProto
  22. def clearProducerVersion: ModelProto
  23. def clearTrainingInfo: ModelProto
  24. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  25. def companion: ModelProto.type
    Definition Classes
    ModelProto → GeneratedMessage
  26. def discardUnknownFields: ModelProto
  27. val docString: Option[String]
  28. val domain: Option[String]
  29. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. val functions: Seq[FunctionProto]
  31. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. def getDocString: String
  33. def getDomain: String
  34. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    ModelProto → GeneratedMessage
  35. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    ModelProto → GeneratedMessage
  36. def getGraph: GraphProto
  37. def getIrVersion: Long
  38. def getModelVersion: Long
  39. def getProducerName: String
  40. def getProducerVersion: String
  41. val graph: Option[GraphProto]
  42. val irVersion: Option[Long]
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. val metadataProps: Seq[StringStringEntryProto]
  45. val modelVersion: Option[Long]
  46. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. val opsetImport: Seq[OperatorSetIdProto]
  50. val producerName: Option[String]
  51. val producerVersion: Option[String]
  52. def serializedSize: Int
    Definition Classes
    ModelProto → GeneratedMessage
  53. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  54. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  55. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  56. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  57. def toProtoString: String
    Definition Classes
    ModelProto → GeneratedMessage
  58. val trainingInfo: Seq[TrainingInfoProto]
  59. val unknownFields: UnknownFieldSet
  60. def update(ms: (Lens[ModelProto, ModelProto]) ⇒ Mutation[ModelProto]*): ModelProto
    Definition Classes
    Updatable
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  63. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  64. def withDocString(__v: String): ModelProto
  65. def withDomain(__v: String): ModelProto
  66. def withFunctions(__v: Seq[FunctionProto]): ModelProto
  67. def withGraph(__v: GraphProto): ModelProto
  68. def withIrVersion(__v: Long): ModelProto
  69. def withMetadataProps(__v: Seq[StringStringEntryProto]): ModelProto
  70. def withModelVersion(__v: Long): ModelProto
  71. def withOpsetImport(__v: Seq[OperatorSetIdProto]): ModelProto
  72. def withProducerName(__v: String): ModelProto
  73. def withProducerVersion(__v: String): ModelProto
  74. def withTrainingInfo(__v: Seq[TrainingInfoProto]): ModelProto
  75. def withUnknownFields(__v: UnknownFieldSet): ModelProto
  76. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  77. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    ModelProto → GeneratedMessage
  78. 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[ModelProto]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped