Struct tfrecord::protobuf::HistogramProto

pub struct HistogramProto {
    pub min: f64,
    pub max: f64,
    pub num: f64,
    pub sum: f64,
    pub sum_squares: f64,
    pub bucket_limit: Vec<f64>,
    pub bucket: Vec<f64>,
}

Serialization format for histogram module in tsl/lib/histogram/histogram.h

Fields

min: f64

max: f64

num: f64

sum: f64

sum_squares: f64

bucket_limit: Vec<f64>

Parallel arrays encoding the bucket boundaries and the bucket values. bucket(i) is the count for the bucket i. The range for a bucket is: i == 0: -DBL_MAX .. bucket_limit(0) i != 0: bucket_limit(i-1) .. bucket_limit(i)

bucket: Vec<f64>

Implementations

impl HistogramProto

pub fn new<'a, L>(bucket_limit: L) -> Result<Self>where L: Into<Cow<'a, [f64]>>,

Create a histogram with bucket limits.

The bucket_limit must be an ordered sequence of finite values. Otherwise it returns an error. The range of each bucket is defined by

• i == 0: f64::MIN..limit[0]
• i > 0: limit[i-1]..limit[i]

pub fn tf_default() -> Self

Create a histogram with TensorFlow’s default bucket limits.

pub fn add_one(&mut self, value: f64)

Add one count to the bucket containing the value.

Panics

It panics if value is not finite.

pub fn add(&mut self, value: f64, count: f64)

Add counts to the bucket containing the value.

Panics

It panics if value is not finite, or count is not finite or not non-negative.

pub fn try_add_one(&mut self, value: f64) -> Result<()>

Add one count to the bucket containing the value.

value must be finite. Otherwise it returns an error.

pub fn try_add(&mut self, value: f64, count: f64) -> Result<()>

Add counts to the bucket containing the value.

value must be finite, and count must be finite and non-negative. Otherwise it returns an error.

pub fn try_iter(&self) -> Result<impl Iterator<Item = (f64, f64)> + '_>

Create an iterator of (limit, count).

If returns an error if the lenghs of bucket_limit and bucket differ.

pub fn iter(&self) -> impl Iterator<Item = (f64, f64)> + '_

Create an iterator of (limit, count).

Panics

It panics if the lenghs of bucket_limit and bucket differ.

pub fn try_from_iter<T, I>(iter: I) -> Result<Self, Error>where T: ToPrimitive, I: IntoIterator<Item = T>,

Create a histogram from an iterator of values, with TensorFlow’s default bucket limits.

Trait Implementations

impl Clone for HistogramProto

fn clone(&self) -> HistogramProto

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HistogramProto

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HistogramProto

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HistogramProto

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A> FromIterator<A> for HistogramProtowhere A: ToPrimitive,

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoHistogram for HistogramProto

fn try_into_histogram(self) -> Result<HistogramProto>

impl Message for HistogramProto

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<HistogramProto> for HistogramProto

fn eq(&self, other: &HistogramProto) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for HistogramProto

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HistogramProto