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

One check the plan asks for. More...

#include <explanation_planner.hpp>

Public Attributes

std::string name
 A stable identifier: "faithfulness", "stability", "robustness", "conservation", "randomization", "null_model", "aggregate", "per_slice_error", or an explainer's own control such as "probe_controls".
 
std::string header
 The header and the calls that run it; empty when pulsatrix has none yet.
 
std::vector< std::string > entry_points
 
std::string purpose
 What it tests, in one sentence.
 
CheckPriority priority = CheckPriority::Recommended
 
std::vector< std::string > applies_to
 The explainers it applies to; empty for all of them.
 
bool available = true
 Whether it can run with what the caller has.
 
std::string unavailable_reason
 Why it can't, when it can't.
 

Detailed Description

One check the plan asks for.

Member Data Documentation

◆ applies_to

std::vector<std::string> pulsatrix::PlannedCheck::applies_to

The explainers it applies to; empty for all of them.

◆ available

bool pulsatrix::PlannedCheck::available = true

Whether it can run with what the caller has.

◆ entry_points

std::vector<std::string> pulsatrix::PlannedCheck::entry_points

◆ header

std::string pulsatrix::PlannedCheck::header

The header and the calls that run it; empty when pulsatrix has none yet.

◆ name

std::string pulsatrix::PlannedCheck::name

A stable identifier: "faithfulness", "stability", "robustness", "conservation", "randomization", "null_model", "aggregate", "per_slice_error", or an explainer's own control such as "probe_controls".

◆ priority

CheckPriority pulsatrix::PlannedCheck::priority = CheckPriority::Recommended

◆ purpose

std::string pulsatrix::PlannedCheck::purpose

What it tests, in one sentence.

◆ unavailable_reason

std::string pulsatrix::PlannedCheck::unavailable_reason

Why it can't, when it can't.


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