pulsatrix 1.1.0
Loading...
Searching...
No Matches
pulsatrix::ContrastiveResult Struct Reference

A pertinent negative or positive. More...

#include <contrastive.hpp>

Public Attributes

bool found = false
 Whether one was found. When not, the other fields describe the input unchanged.
 
int64_t original_class = 0
 The model's class for the input.
 
int64_t explanation_class = 0
 The class of the explanation: another class for a pertinent negative, the same one for a pertinent positive.
 
std::vector< float > delta
 δ, one value per feature.
 
std::vector< float > explanation
 What the model sees: x + δ for a pertinent negative, b + δ for a pertinent positive.
 
double l1 = 0.0
 |δ|_1, and the features δ changes.
 
std::vector< int64_t > features
 
float c = 0.0f
 The weight c of the explanation returned.
 

Detailed Description

A pertinent negative or positive.

Member Data Documentation

◆ c

float pulsatrix::ContrastiveResult::c = 0.0f

The weight c of the explanation returned.

◆ delta

std::vector<float> pulsatrix::ContrastiveResult::delta

δ, one value per feature.

◆ explanation

std::vector<float> pulsatrix::ContrastiveResult::explanation

What the model sees: x + δ for a pertinent negative, b + δ for a pertinent positive.

◆ explanation_class

int64_t pulsatrix::ContrastiveResult::explanation_class = 0

The class of the explanation: another class for a pertinent negative, the same one for a pertinent positive.

◆ features

std::vector<int64_t> pulsatrix::ContrastiveResult::features

◆ found

bool pulsatrix::ContrastiveResult::found = false

Whether one was found. When not, the other fields describe the input unchanged.

◆ l1

double pulsatrix::ContrastiveResult::l1 = 0.0

|δ|_1, and the features δ changes.

◆ original_class

int64_t pulsatrix::ContrastiveResult::original_class = 0

The model's class for the input.


The documentation for this struct was generated from the following file: