summary_go_proto

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	DataClass_name = map[int32]string{
		0: "DATA_CLASS_UNKNOWN",
		1: "DATA_CLASS_SCALAR",
		2: "DATA_CLASS_TENSOR",
		3: "DATA_CLASS_BLOB_SEQUENCE",
	}
	DataClass_value = map[string]int32{
		"DATA_CLASS_UNKNOWN":       0,
		"DATA_CLASS_SCALAR":        1,
		"DATA_CLASS_TENSOR":        2,
		"DATA_CLASS_BLOB_SEQUENCE": 3,
	}
)

Enum value maps for DataClass.

View Source 
var File_tensorflow_core_framework_summary_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type DataClass 

type DataClass int32
const (
	// Unknown data class, used (implicitly) for legacy data. Will not be
	// processed by data ingestion pipelines.
	DataClass_DATA_CLASS_UNKNOWN DataClass = 0
	// Scalar time series. Each `Value` for the corresponding tag must have
	// `tensor` set to a rank-0 tensor of type `DT_FLOAT` (float32).
	DataClass_DATA_CLASS_SCALAR DataClass = 1
	// Tensor time series. Each `Value` for the corresponding tag must have
	// `tensor` set. The tensor value is arbitrary, but should be small to
	// accommodate direct storage in database backends: an upper bound of a few
	// kilobytes is a reasonable rule of thumb.
	DataClass_DATA_CLASS_TENSOR DataClass = 2
	// Blob sequence time series. Each `Value` for the corresponding tag must
	// have `tensor` set to a rank-1 tensor of bytestring dtype.
	DataClass_DATA_CLASS_BLOB_SEQUENCE DataClass = 3
)

func (DataClass) Descriptor 

func (DataClass) Descriptor() protoreflect.EnumDescriptor

func (DataClass) Enum 

func (x DataClass) Enum() *DataClass

func (DataClass) EnumDescriptor deprecated 

func (DataClass) EnumDescriptor() ([]byte, []int)

Deprecated: Use DataClass.Descriptor instead.

func (DataClass) Number 

func (x DataClass) Number() protoreflect.EnumNumber

func (DataClass) String 

func (x DataClass) String() string

func (DataClass) Type 

func (DataClass) Type() protoreflect.EnumType

type HistogramProto 

type HistogramProto = for_core_protos_go_proto.HistogramProto

type Summary 

type Summary struct {

	// Set of values for the summary.
	Value []*Summary_Value `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A Summary is a set of named values to be displayed by the visualizer.

Summaries are produced regularly during training, as controlled by the "summary_interval_secs" attribute of the training operation. Summaries are also produced at the end of an evaluation.

func (*Summary) Descriptor deprecated 

func (*Summary) Descriptor() ([]byte, []int)

Deprecated: Use Summary.ProtoReflect.Descriptor instead.

func (*Summary) GetValue 

func (x *Summary) GetValue() []*Summary_Value

func (*Summary) ProtoMessage 

func (*Summary) ProtoMessage()

func (*Summary) ProtoReflect 

func (x *Summary) ProtoReflect() protoreflect.Message

func (*Summary) Reset 

func (x *Summary) Reset()

func (*Summary) String 

func (x *Summary) String() string

type SummaryDescription 

type SummaryDescription struct {

	// Hint on how plugins should process the data in this series.
	// Supported values include "scalar", "histogram", "image", "audio"
	TypeHint string `protobuf:"bytes,1,opt,name=type_hint,json=typeHint,proto3" json:"type_hint,omitempty"`
	// contains filtered or unexported fields
}

Metadata associated with a series of Summary data

func (*SummaryDescription) Descriptor deprecated 

func (*SummaryDescription) Descriptor() ([]byte, []int)

Deprecated: Use SummaryDescription.ProtoReflect.Descriptor instead.

func (*SummaryDescription) GetTypeHint 

func (x *SummaryDescription) GetTypeHint() string

func (*SummaryDescription) ProtoMessage 

func (*SummaryDescription) ProtoMessage()

func (*SummaryDescription) ProtoReflect 

func (x *SummaryDescription) ProtoReflect() protoreflect.Message

func (*SummaryDescription) Reset 

func (x *SummaryDescription) Reset()

func (*SummaryDescription) String 

func (x *SummaryDescription) String() string

type SummaryMetadata 

type SummaryMetadata struct {

	// Data that associates a summary with a certain plugin.
	PluginData *SummaryMetadata_PluginData `protobuf:"bytes,1,opt,name=plugin_data,json=pluginData,proto3" json:"plugin_data,omitempty"`
	// Display name for viewing in TensorBoard.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Longform readable description of the summary sequence. Markdown supported.
	SummaryDescription string `protobuf:"bytes,3,opt,name=summary_description,json=summaryDescription,proto3" json:"summary_description,omitempty"`
	// 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. See `DataClass` docs for details.
	DataClass DataClass `protobuf:"varint,4,opt,name=data_class,json=dataClass,proto3,enum=tensorflow.DataClass" json:"data_class,omitempty"`
	// contains filtered or unexported fields
}

A SummaryMetadata encapsulates information on which plugins are able to make use of a certain summary value.

func (*SummaryMetadata) Descriptor deprecated 

func (*SummaryMetadata) Descriptor() ([]byte, []int)

Deprecated: Use SummaryMetadata.ProtoReflect.Descriptor instead.

func (*SummaryMetadata) GetDataClass 

func (x *SummaryMetadata) GetDataClass() DataClass

func (*SummaryMetadata) GetDisplayName 

func (x *SummaryMetadata) GetDisplayName() string

func (*SummaryMetadata) GetPluginData 

func (x *SummaryMetadata) GetPluginData() *SummaryMetadata_PluginData

func (*SummaryMetadata) GetSummaryDescription 

func (x *SummaryMetadata) GetSummaryDescription() string

func (*SummaryMetadata) ProtoMessage 

func (*SummaryMetadata) ProtoMessage()

func (*SummaryMetadata) ProtoReflect 

func (x *SummaryMetadata) ProtoReflect() protoreflect.Message

func (*SummaryMetadata) Reset 

func (x *SummaryMetadata) Reset()

func (*SummaryMetadata) String 

func (x *SummaryMetadata) String() string

type SummaryMetadata_PluginData 

type SummaryMetadata_PluginData struct {

	// The name of the plugin this data pertains to.
	PluginName string `protobuf:"bytes,1,opt,name=plugin_name,json=pluginName,proto3" json:"plugin_name,omitempty"`
	// The content to store for the plugin. The best practice is for this to be
	// a binary serialized protocol buffer.
	Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

func (*SummaryMetadata_PluginData) Descriptor deprecated 

func (*SummaryMetadata_PluginData) Descriptor() ([]byte, []int)

Deprecated: Use SummaryMetadata_PluginData.ProtoReflect.Descriptor instead.

func (*SummaryMetadata_PluginData) GetContent 

func (x *SummaryMetadata_PluginData) GetContent() []byte

func (*SummaryMetadata_PluginData) GetPluginName 

func (x *SummaryMetadata_PluginData) GetPluginName() string

func (*SummaryMetadata_PluginData) ProtoMessage 

func (*SummaryMetadata_PluginData) ProtoMessage()

func (*SummaryMetadata_PluginData) ProtoReflect 

func (x *SummaryMetadata_PluginData) ProtoReflect() protoreflect.Message

func (*SummaryMetadata_PluginData) Reset 

func (x *SummaryMetadata_PluginData) Reset()

func (*SummaryMetadata_PluginData) String 

func (x *SummaryMetadata_PluginData) String() string

type Summary_Audio 

type Summary_Audio struct {

	// Sample rate of the audio in Hz.
	SampleRate float32 `protobuf:"fixed32,1,opt,name=sample_rate,json=sampleRate,proto3" json:"sample_rate,omitempty"`
	// Number of channels of audio.
	NumChannels int64 `protobuf:"varint,2,opt,name=num_channels,json=numChannels,proto3" json:"num_channels,omitempty"`
	// Length of the audio in frames (samples per channel).
	LengthFrames int64 `protobuf:"varint,3,opt,name=length_frames,json=lengthFrames,proto3" json:"length_frames,omitempty"`
	// Encoded audio data and its associated RFC 2045 content type (e.g.
	// "audio/wav").
	EncodedAudioString []byte `protobuf:"bytes,4,opt,name=encoded_audio_string,json=encodedAudioString,proto3" json:"encoded_audio_string,omitempty"`
	ContentType        string `protobuf:"bytes,5,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// contains filtered or unexported fields
}

func (*Summary_Audio) Descriptor deprecated 

func (*Summary_Audio) Descriptor() ([]byte, []int)

Deprecated: Use Summary_Audio.ProtoReflect.Descriptor instead.

func (*Summary_Audio) GetContentType 

func (x *Summary_Audio) GetContentType() string

func (*Summary_Audio) GetEncodedAudioString 

func (x *Summary_Audio) GetEncodedAudioString() []byte

func (*Summary_Audio) GetLengthFrames 

func (x *Summary_Audio) GetLengthFrames() int64

func (*Summary_Audio) GetNumChannels 

func (x *Summary_Audio) GetNumChannels() int64

func (*Summary_Audio) GetSampleRate 

func (x *Summary_Audio) GetSampleRate() float32

func (*Summary_Audio) ProtoMessage 

func (*Summary_Audio) ProtoMessage()

func (*Summary_Audio) ProtoReflect 

func (x *Summary_Audio) ProtoReflect() protoreflect.Message

func (*Summary_Audio) Reset 

func (x *Summary_Audio) Reset()

func (*Summary_Audio) String 

func (x *Summary_Audio) String() string

type Summary_Image 

type Summary_Image struct {

	// Dimensions of the image.
	Height int32 `protobuf:"varint,1,opt,name=height,proto3" json:"height,omitempty"`
	Width  int32 `protobuf:"varint,2,opt,name=width,proto3" json:"width,omitempty"`
	// Valid colorspace values are
	//
	//	1 - grayscale
	//	2 - grayscale + alpha
	//	3 - RGB
	//	4 - RGBA
	//	5 - DIGITAL_YUV
	//	6 - BGRA
	Colorspace int32 `protobuf:"varint,3,opt,name=colorspace,proto3" json:"colorspace,omitempty"`
	// Image data in encoded format.  All image formats supported by
	// image_codec::CoderUtil can be stored here.
	EncodedImageString []byte `protobuf:"bytes,4,opt,name=encoded_image_string,json=encodedImageString,proto3" json:"encoded_image_string,omitempty"`
	// contains filtered or unexported fields
}

func (*Summary_Image) Descriptor deprecated 

func (*Summary_Image) Descriptor() ([]byte, []int)

Deprecated: Use Summary_Image.ProtoReflect.Descriptor instead.

func (*Summary_Image) GetColorspace 

func (x *Summary_Image) GetColorspace() int32

func (*Summary_Image) GetEncodedImageString 

func (x *Summary_Image) GetEncodedImageString() []byte

func (*Summary_Image) GetHeight 

func (x *Summary_Image) GetHeight() int32

func (*Summary_Image) GetWidth 

func (x *Summary_Image) GetWidth() int32

func (*Summary_Image) ProtoMessage 

func (*Summary_Image) ProtoMessage()

func (*Summary_Image) ProtoReflect 

func (x *Summary_Image) ProtoReflect() protoreflect.Message

func (*Summary_Image) Reset 

func (x *Summary_Image) Reset()

func (*Summary_Image) String 

func (x *Summary_Image) String() string

type Summary_Value 

type Summary_Value struct {

	// This field is deprecated and will not be set.
	NodeName string `protobuf:"bytes,7,opt,name=node_name,json=nodeName,proto3" json:"node_name,omitempty"`
	// Tag name for the data. Used by TensorBoard plugins to organize data. Tags
	// are often organized by scope (which contains slashes to convey
	// hierarchy). For example: foo/bar/0
	Tag string `protobuf:"bytes,1,opt,name=tag,proto3" json:"tag,omitempty"`
	// Contains metadata on the summary value such as which plugins may use it.
	// Take note that many summary values may lack a metadata field. This is
	// because the FileWriter only keeps a metadata object on the first summary
	// value with a certain tag for each tag. TensorBoard then remembers which
	// tags are associated with which plugins. This saves space.
	Metadata *SummaryMetadata `protobuf:"bytes,9,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Value associated with the tag.
	//
	// Types that are assignable to Value:
	//
	//	*Summary_Value_SimpleValue
	//	*Summary_Value_ObsoleteOldStyleHistogram
	//	*Summary_Value_Image
	//	*Summary_Value_Histo
	//	*Summary_Value_Audio
	//	*Summary_Value_Tensor
	Value isSummary_Value_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

func (*Summary_Value) Descriptor deprecated 

func (*Summary_Value) Descriptor() ([]byte, []int)

Deprecated: Use Summary_Value.ProtoReflect.Descriptor instead.

func (*Summary_Value) GetAudio 

func (x *Summary_Value) GetAudio() *Summary_Audio

func (*Summary_Value) GetHisto 

func (x *Summary_Value) GetHisto() *for_core_protos_go_proto.HistogramProto

func (*Summary_Value) GetImage 

func (x *Summary_Value) GetImage() *Summary_Image

func (*Summary_Value) GetMetadata 

func (x *Summary_Value) GetMetadata() *SummaryMetadata

func (*Summary_Value) GetNodeName 

func (x *Summary_Value) GetNodeName() string

func (*Summary_Value) GetObsoleteOldStyleHistogram 

func (x *Summary_Value) GetObsoleteOldStyleHistogram() []byte

func (*Summary_Value) GetSimpleValue 

func (x *Summary_Value) GetSimpleValue() float32

func (*Summary_Value) GetTag 

func (x *Summary_Value) GetTag() string

func (*Summary_Value) GetTensor 

func (x *Summary_Value) GetTensor() *tensor_go_proto.TensorProto

func (*Summary_Value) GetValue 

func (m *Summary_Value) GetValue() isSummary_Value_Value

func (*Summary_Value) ProtoMessage 

func (*Summary_Value) ProtoMessage()

func (*Summary_Value) ProtoReflect 

func (x *Summary_Value) ProtoReflect() protoreflect.Message

func (*Summary_Value) Reset 

func (x *Summary_Value) Reset()

func (*Summary_Value) String 

func (x *Summary_Value) String() string

type Summary_Value_Audio 

type Summary_Value_Audio struct {
	Audio *Summary_Audio `protobuf:"bytes,6,opt,name=audio,proto3,oneof"`
}

type Summary_Value_Histo 

type Summary_Value_Histo struct {
	Histo *for_core_protos_go_proto.HistogramProto `protobuf:"bytes,5,opt,name=histo,proto3,oneof"`
}

type Summary_Value_Image 

type Summary_Value_Image struct {
	Image *Summary_Image `protobuf:"bytes,4,opt,name=image,proto3,oneof"`
}

type Summary_Value_ObsoleteOldStyleHistogram 

type Summary_Value_ObsoleteOldStyleHistogram struct {
	ObsoleteOldStyleHistogram []byte `protobuf:"bytes,3,opt,name=obsolete_old_style_histogram,json=obsoleteOldStyleHistogram,proto3,oneof"`
}

type Summary_Value_SimpleValue 

type Summary_Value_SimpleValue struct {
	SimpleValue float32 `protobuf:"fixed32,2,opt,name=simple_value,json=simpleValue,proto3,oneof"`
}

type Summary_Value_Tensor 

type Summary_Value_Tensor struct {
	Tensor *tensor_go_proto.TensorProto `protobuf:"bytes,8,opt,name=tensor,proto3,oneof"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.