Struct HumanEvaluationCustomMetric 

#[non_exhaustive]
pub struct HumanEvaluationCustomMetric {
    pub name: String,
    pub description: Option<String>,
    pub rating_method: String,
}

In a model evaluation job that uses human workers you must define the name of the metric, and how you want that metric rated ratingMethod, and an optional description of the metric.

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.

name: String

The name of the metric. Your human evaluators will see this name in the evaluation UI.

description: Option<String>

An optional description of the metric. Use this parameter to provide more details about the metric.

rating_method: String

Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank

Implementations

impl HumanEvaluationCustomMetric

pub fn name(&self) -> &str

The name of the metric. Your human evaluators will see this name in the evaluation UI.

pub fn description(&self) -> Option<&str>

An optional description of the metric. Use this parameter to provide more details about the metric.

pub fn rating_method(&self) -> &str

Choose how you want your human workers to evaluation your model. Valid values for rating methods are ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale, ComparisonChoice, and ComparisonRank

impl HumanEvaluationCustomMetric

pub fn builder() -> HumanEvaluationCustomMetricBuilder

Creates a new builder-style object to manufacture HumanEvaluationCustomMetric.

Trait Implementations

impl Clone for HumanEvaluationCustomMetric

fn clone(&self) -> HumanEvaluationCustomMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HumanEvaluationCustomMetric

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

Formats the value using the given formatter.

impl PartialEq for HumanEvaluationCustomMetric

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