Package org.tensorflow.framework

Class SummaryMetadata

  • All Implemented Interfaces:
    Serializable, org.nd4j.shade.protobuf.Message, org.nd4j.shade.protobuf.MessageLite, org.nd4j.shade.protobuf.MessageLiteOrBuilder, org.nd4j.shade.protobuf.MessageOrBuilder, SummaryMetadataOrBuilder
    public final class SummaryMetadata
extends org.nd4j.shade.protobuf.GeneratedMessageV3
implements SummaryMetadataOrBuilder
     A SummaryMetadata encapsulates information on which plugins are able to make
 use of a certain summary value.
    Protobuf type tensorflow.SummaryMetadata
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SummaryMetadata.Builder
      A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.
      static class  SummaryMetadata.PluginData
      Protobuf type tensorflow.SummaryMetadata.PluginData
      static interface  SummaryMetadata.PluginDataOrBuilder  

      • Nested classes/interfaces inherited from class org.nd4j.shade.protobuf.GeneratedMessageV3

        org.nd4j.shade.protobuf.GeneratedMessageV3.BuilderParent, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage>, org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends org.nd4j.shade.protobuf.GeneratedMessageV3.ExtendableMessage>, org.nd4j.shade.protobuf.GeneratedMessageV3.FieldAccessorTable, org.nd4j.shade.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class org.nd4j.shade.protobuf.AbstractMessageLite

        org.nd4j.shade.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DISPLAY_NAME_FIELD_NUMBER  
      static int PLUGIN_DATA_FIELD_NUMBER  
      static int SUMMARY_DESCRIPTION_FIELD_NUMBER  

      • Fields inherited from class org.nd4j.shade.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class org.nd4j.shade.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class org.nd4j.shade.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • PLUGIN_DATA_FIELD_NUMBER

        public static final int PLUGIN_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISPLAY_NAME_FIELD_NUMBER

        public static final int DISPLAY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SUMMARY_DESCRIPTION_FIELD_NUMBER

        public static final int SUMMARY_DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(org.nd4j.shade.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final org.nd4j.shade.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface org.nd4j.shade.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final org.nd4j.shade.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected org.nd4j.shade.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • hasPluginData

        public boolean hasPluginData()
         Data that associates a summary with a certain plugin.
        .tensorflow.SummaryMetadata.PluginData plugin_data = 1;
        Specified by:
        hasPluginData in interface SummaryMetadataOrBuilder
        Returns:
        Whether the pluginData field is set.

      • getDisplayNameBytes

        public org.nd4j.shade.protobuf.ByteString getDisplayNameBytes()
         Display name for viewing in TensorBoard.
        string display_name = 2;
        Specified by:
        getDisplayNameBytes in interface SummaryMetadataOrBuilder
        Returns:
        The bytes for displayName.

      • getSummaryDescription

        public String getSummaryDescription()
         Longform readable description of the summary sequence. Markdown supported.
        string summary_description = 3;
        Specified by:
        getSummaryDescription in interface SummaryMetadataOrBuilder
        Returns:
        The summaryDescription.

      • getSummaryDescriptionBytes

        public org.nd4j.shade.protobuf.ByteString getSummaryDescriptionBytes()
         Longform readable description of the summary sequence. Markdown supported.
        string summary_description = 3;
        Specified by:
        getSummaryDescriptionBytes in interface SummaryMetadataOrBuilder
        Returns:
        The bytes for summaryDescription.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(org.nd4j.shade.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        writeTo in class org.nd4j.shade.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        getSerializedSize in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface org.nd4j.shade.protobuf.Message
        Overrides:
        equals in class org.nd4j.shade.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface org.nd4j.shade.protobuf.Message
        Overrides:
        hashCode in class org.nd4j.shade.protobuf.AbstractMessage

      • parseFrom

        public static SummaryMetadata parseFrom​(ByteBuffer data)
                                 throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SummaryMetadata parseFrom​(ByteBuffer data,
                                        org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SummaryMetadata parseFrom​(org.nd4j.shade.protobuf.ByteString data)
                                 throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SummaryMetadata parseFrom​(org.nd4j.shade.protobuf.ByteString data,
                                        org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SummaryMetadata parseFrom​(byte[] data)
                                 throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SummaryMetadata parseFrom​(byte[] data,
                                        org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws org.nd4j.shade.protobuf.InvalidProtocolBufferException
        Throws:
        org.nd4j.shade.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SummaryMetadata parseFrom​(org.nd4j.shade.protobuf.CodedInputStream input,
                                        org.nd4j.shade.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public SummaryMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface org.nd4j.shade.protobuf.Message
        Specified by:
        newBuilderForType in interface org.nd4j.shade.protobuf.MessageLite

      • toBuilder

        public SummaryMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface org.nd4j.shade.protobuf.Message
        Specified by:
        toBuilder in interface org.nd4j.shade.protobuf.MessageLite

      • newBuilderForType

        protected SummaryMetadata.Builder newBuilderForType​(org.nd4j.shade.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • parser

        public static org.nd4j.shade.protobuf.Parser<SummaryMetadata> parser()

      • getParserForType

        public org.nd4j.shade.protobuf.Parser<SummaryMetadata> getParserForType()
        Specified by:
        getParserForType in interface org.nd4j.shade.protobuf.Message
        Specified by:
        getParserForType in interface org.nd4j.shade.protobuf.MessageLite
        Overrides:
        getParserForType in class org.nd4j.shade.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public SummaryMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface org.nd4j.shade.protobuf.MessageOrBuilder