Struct MetricSpec 

pub struct MetricSpec {

    pub schema_version: u32,
    pub metric_id: String,
    pub kind: SemanticSpecKind,
    pub task_kinds: BTreeSet<LearningTaskKind>,
    pub prediction_kinds: BTreeSet<PredictionKind>,
    pub objective: MetricObjective,
    pub supported_levels: BTreeSet<PredictionLevel>,
    pub decomposition: MetricDecomposition,
    pub reduction: MetricReduction,
    pub required_inputs: BTreeSet<CriterionInput>,
    pub capabilities: BTreeSet<MetricCapability>,
    pub parameters: Value,
    pub spec_fingerprint: String,
}

Fields

schema_version: u32

metric_id: String

kind: SemanticSpecKind

task_kinds: BTreeSet<LearningTaskKind>

prediction_kinds: BTreeSet<PredictionKind>

objective: MetricObjective

supported_levels: BTreeSet<PredictionLevel>

decomposition: MetricDecomposition

reduction: MetricReduction

required_inputs: BTreeSet<CriterionInput>

capabilities: BTreeSet<MetricCapability>

parameters: Value

spec_fingerprint: String

Implementations

impl MetricSpec

pub fn new( metric_id: impl Into<String>, kind: SemanticSpecKind, task_kinds: BTreeSet<LearningTaskKind>, prediction_kinds: BTreeSet<PredictionKind>, objective: MetricObjective, supported_levels: BTreeSet<PredictionLevel>, decomposition: MetricDecomposition, reduction: MetricReduction, required_inputs: BTreeSet<CriterionInput>, capabilities: BTreeSet<MetricCapability>, parameters: Value, ) -> Result<MetricSpec, DagMlError>

pub fn from_json(json: &str) -> Result<MetricSpec, DagMlError>

pub fn compute_fingerprint(&self) -> Result<String, DagMlError>

pub fn validate(&self) -> Result<(), DagMlError>

pub fn validate_compatibility( &self, task_kind: LearningTaskKind, prediction_kind: PredictionKind, level: PredictionLevel, ) -> Result<(), DagMlError>

Trait Implementations

impl Clone for MetricSpec

fn clone(&self) -> MetricSpec

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MetricSpec

impl PartialEq for MetricSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MetricSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MetricSpec