final case class SummaryMetadata(pluginData: Option[PluginData] = _root_.scala.None, displayName: String = "", summaryDescription: String = "", dataClass: DataClass = ..., unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[SummaryMetadata] with Product with Serializable
A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.
- pluginData
Data that associates a summary with a certain plugin.
- displayName
Display name for viewing in TensorBoard.
- summaryDescription
Longform readable description of the summary sequence. Markdown supported.
- dataClass
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. SeeDataClass
docs for details.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- SummaryMetadata
- Updatable
- GeneratedMessage
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
SummaryMetadata(pluginData: Option[PluginData] = _root_.scala.None, displayName: String = "", summaryDescription: String = "", dataClass: DataClass = ..., unknownFields: UnknownFieldSet = ...)
- pluginData
Data that associates a summary with a certain plugin.
- displayName
Display name for viewing in TensorBoard.
- summaryDescription
Longform readable description of the summary sequence. Markdown supported.
- dataClass
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. SeeDataClass
docs for details.
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearPluginData: SummaryMetadata
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
companion: SummaryMetadata.type
- Definition Classes
- SummaryMetadata → GeneratedMessage
- val dataClass: DataClass
- def discardUnknownFields: SummaryMetadata
- val displayName: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getField(__field: FieldDescriptor): PValue
- Definition Classes
- SummaryMetadata → GeneratedMessage
-
def
getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- SummaryMetadata → GeneratedMessage
- def getPluginData: PluginData
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val pluginData: Option[PluginData]
-
def
serializedSize: Int
- Definition Classes
- SummaryMetadata → GeneratedMessage
- val summaryDescription: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
-
final
def
toByteString: ByteString
- Definition Classes
- GeneratedMessage
-
final
def
toPMessage: PMessage
- Definition Classes
- GeneratedMessage
-
def
toProtoString: String
- Definition Classes
- SummaryMetadata → GeneratedMessage
- val unknownFields: UnknownFieldSet
-
def
update(ms: (Lens[SummaryMetadata, SummaryMetadata]) ⇒ Mutation[SummaryMetadata]*): SummaryMetadata
- Definition Classes
- Updatable
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- def withDataClass(__v: DataClass): SummaryMetadata
- def withDisplayName(__v: String): SummaryMetadata
- def withPluginData(__v: PluginData): SummaryMetadata
- def withSummaryDescription(__v: String): SummaryMetadata
- def withUnknownFields(__v: UnknownFieldSet): SummaryMetadata
-
final
def
writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
-
def
writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- SummaryMetadata → GeneratedMessage
-
final
def
writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated