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

pulsatrix.partial_dependence.v1: a partial dependence curve over one feature, with the individual (ICE) curves it averages when they were computed (CFS-1). More...

#include <document.hpp>

Public Attributes

std::string method = "partial_dependence"
 "partial_dependence", or "ale" for accumulated local effects (CFS-2), whose grid is the bin edges and which has no ICE curves. A reader treats a missing member as "partial_dependence".
 
std::string feature
 Name of the varied feature. Optional.
 
std::string target
 What the curve predicts, for example a class name. Optional.
 
std::vector< float > grid
 Strictly increasing feature values.
 
std::vector< float > partial_dependence
 One value per grid point.
 
int64_t num_instances = 0
 Number of ICE curves; 0 when the document holds the average only.
 
std::vector< float > ice
 Row-major (num_instances, grid.size()), or empty.
 
std::vector< float > feature_values
 Each instance's own value of the feature (num_instances of them, or any number for ALE), or empty.
 

Detailed Description

pulsatrix.partial_dependence.v1: a partial dependence curve over one feature, with the individual (ICE) curves it averages when they were computed (CFS-1).

Note
Holds the raw curves only. Centered and derivative ICE are views of them, computed by whoever draws them (IceResult::centered, IceResult::derivative), so every renderer agrees.

Member Data Documentation

◆ feature

std::string pulsatrix::PartialDependenceDocument::feature

Name of the varied feature. Optional.

◆ feature_values

std::vector<float> pulsatrix::PartialDependenceDocument::feature_values

Each instance's own value of the feature (num_instances of them, or any number for ALE), or empty.

◆ grid

std::vector<float> pulsatrix::PartialDependenceDocument::grid

Strictly increasing feature values.

◆ ice

std::vector<float> pulsatrix::PartialDependenceDocument::ice

Row-major (num_instances, grid.size()), or empty.

◆ method

std::string pulsatrix::PartialDependenceDocument::method = "partial_dependence"

"partial_dependence", or "ale" for accumulated local effects (CFS-2), whose grid is the bin edges and which has no ICE curves. A reader treats a missing member as "partial_dependence".

◆ num_instances

int64_t pulsatrix::PartialDependenceDocument::num_instances = 0

Number of ICE curves; 0 when the document holds the average only.

◆ partial_dependence

std::vector<float> pulsatrix::PartialDependenceDocument::partial_dependence

One value per grid point.

◆ target

std::string pulsatrix::PartialDependenceDocument::target

What the curve predicts, for example a class name. Optional.


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