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

What ExplanationPlanner::plan() returns. More...

#include <explanation_planner.hpp>

Collaboration diagram for pulsatrix::ExplanationPlan:

Public Member Functions

bool complete () const
 Whether every required check can run and some explainer applies.
 

Public Attributes

XaiQuestion question = XaiQuestion::Why
 
XaiReason reason = XaiReason::Justify
 
ModelTraits traits
 
std::vector< PlannedExplainer > explainers
 The explainers to use, best first. Empty when none can answer the question here.
 
std::vector< PlannedCheck > checks
 The checks to run on their results, required ones first.
 
std::vector< ExcludedExplainer > excluded
 The explainers that answer the question but need more than the caller has.
 
std::vector< std::string > warnings
 What the plan can't deliver: a question with no explainer, a required check that can't run. A report built from the plan should repeat these.
 

Detailed Description

Member Function Documentation

◆ complete()

bool pulsatrix::ExplanationPlan::complete ( ) const

Whether every required check can run and some explainer applies.

Member Data Documentation

◆ checks

std::vector<PlannedCheck> pulsatrix::ExplanationPlan::checks

The checks to run on their results, required ones first.

◆ excluded

std::vector<ExcludedExplainer> pulsatrix::ExplanationPlan::excluded

The explainers that answer the question but need more than the caller has.

◆ explainers

std::vector<PlannedExplainer> pulsatrix::ExplanationPlan::explainers

The explainers to use, best first. Empty when none can answer the question here.

◆ question

XaiQuestion pulsatrix::ExplanationPlan::question = XaiQuestion::Why

◆ reason

XaiReason pulsatrix::ExplanationPlan::reason = XaiReason::Justify

◆ traits

ModelTraits pulsatrix::ExplanationPlan::traits

◆ warnings

std::vector<std::string> pulsatrix::ExplanationPlan::warnings

What the plan can't deliver: a question with no explainer, a required check that can't run. A report built from the plan should repeat these.


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