Struct MetricSpec

#[non_exhaustive]
pub struct MetricSpec {
    pub metric_id: String,
    pub goal: GoalType,
    pub safety_config: Option<SafetyMetricConfig>,
    /* private fields */
}

Represents a metric to optimize.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

metric_id: String

Required. The ID of the metric. Must not contain whitespaces and must be unique amongst all MetricSpecs.

goal: GoalType

Required. The optimization goal of the metric.

safety_config: Option<SafetyMetricConfig>

Used for safe search. In the case, the metric will be a safety metric. You must provide a separate metric for objective metric.

Implementations

impl MetricSpec

pub fn new() -> Self

pub fn set_metric_id<T: Into<String>>(self, v: T) -> Self

Sets the value of metric_id.

pub fn set_goal<T: Into<GoalType>>(self, v: T) -> Self

Sets the value of goal.

pub fn set_safety_config<T: Into<Option<SafetyMetricConfig>>>( self, v: T, ) -> Self

Sets the value of safety_config.

Trait Implementations

impl Clone for MetricSpec

fn clone(&self) -> MetricSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricSpec

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

Formats the value using the given formatter.

impl Default for MetricSpec

fn default() -> MetricSpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricSpec

where MetricSpec: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for MetricSpec

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MetricSpec

fn eq(&self, other: &MetricSpec) -> 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 Serialize for MetricSpec

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 MetricSpec