Struct HyperparameterSpec

pub struct HyperparameterSpec {
    pub goal: i32,
    pub params: Vec<ParameterSpec>,
    pub max_trials: i32,
    pub max_parallel_trials: i32,
    pub hyperparameter_metric_tag: String,
}

Represents a set of hyperparameters to optimize.

Fields

goal: i32

Required. The type of goal to use for tuning. Available types are MAXIMIZE and MINIMIZE.

Defaults to MAXIMIZE.

params: Vec<ParameterSpec>

Required. The set of parameters to tune.

max_trials: i32

Optional. How many training trials should be attempted to optimize the specified hyperparameters.

Defaults to one.

max_parallel_trials: i32

Optional. The number of training trials to run concurrently. You can reduce the time it takes to perform hyperparameter tuning by adding trials in parallel. However, each trail only benefits from the information gained in completed trials. That means that a trial does not get access to the results of trials running at the same time, which could reduce the quality of the overall optimization.

Each trial will use the same scale tier and machine types.

Defaults to one.

hyperparameter_metric_tag: String

Optional. The Tensorflow summary tag name to use for optimizing trials. For current versions of Tensorflow, this tag name should exactly match what is shown in Tensorboard, including all scopes. For versions of Tensorflow prior to 0.12, this should be only the tag passed to tf.Summary. By default, “training/hptuning/metric” will be used.

Implementations

impl HyperparameterSpec

pub fn goal(&self) -> GoalType

Returns the enum value of goal, or the default if the field is set to an invalid enum value.

pub fn set_goal(&mut self, value: GoalType)

Sets goal to the provided enum value.

Trait Implementations

impl Clone for HyperparameterSpec

fn clone(&self) -> HyperparameterSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HyperparameterSpec

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

Formats the value using the given formatter.

impl Default for HyperparameterSpec

fn default() -> HyperparameterSpec

Returns the “default value” for a type.

impl Message for HyperparameterSpec

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_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 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 for HyperparameterSpec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for HyperparameterSpec