Struct ciphercore_base::ops::auc::AucScore

pub struct AucScore {
    pub fp: FixedPrecisionConfig,
}

A structure that defines the custom operation AucMetric Area Under the Receiver Operating Characteristic Curve (ROC AUC).

This is the most commonly used metric for binary classification problems. See also https://scikit-learn.org/stable/modules/generated/sklearn.metrics.roc_auc_score.html.

Custom operation arguments

• Node containing a signed 1-dimensional 64-bit array with labels (0 or 1, possibly in the fixed precision format);
• Node containing a 1-dimensional 64-bit array with predictions (can be integers or fixed precision, only relative order matters).

Custom operation returns

New AucScore node

Example

let c = create_context().unwrap();
let g = c.create_graph().unwrap();
let t = array_type(vec![5], INT64);
let y_true = g.input(t.clone()).unwrap();
let y_pred = g.input(t.clone()).unwrap();
let fp = FixedPrecisionConfig::default();
let auc = g.custom_op(CustomOperation::new(AucScore {fp}), vec![y_true, y_pred]).unwrap();

Fields

fp: FixedPrecisionConfig

Fixed precision config for labels.

Trait Implementations

impl CustomOperationBody for AucScore

fn instantiate( &self, context: Context, arguments_types: Vec<Type> ) -> Result<Graph>

Defines the logic of a custom operation.

fn get_name(&self) -> String

Specifies and returns the name of this custom operation.

impl Debug for AucScore

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AucScore

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

Deserialize this value from the given Serde deserializer.

impl Hash for AucScore

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<AucScore> for AucScore

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

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

Serialize this value into the given Serde serializer.

impl Eq for AucScore

impl StructuralEq for AucScore

impl StructuralPartialEq for AucScore