Skip to main content

Module explain

Module explain 

Source
Expand description

Explainability toolkit for FPC-based scalar-on-function models.

Structs§

AleResult
Result of Accumulated Local Effects analysis.
AnchorCondition
A single condition in an anchor rule.
AnchorResult
Result of anchor explanation for one observation.
AnchorRule
An anchor rule consisting of FPC score conditions.
BetaDecomposition
Per-FPC decomposition of the functional coefficient β(t).
CalibrationDiagnosticsResult
Calibration diagnostics for a functional logistic regression model.
ConditionalPermutationImportanceResult
Result of conditional permutation importance.
ConformalPredictionResult
Result of split-conformal prediction.
CounterfactualResult
Result of a counterfactual explanation.
DfbetasDffitsResult
Result of DFBETAS/DFFITS influence diagnostics.
DomainSelectionResult
Result of domain selection analysis.
EceResult
Result of expected calibration error analysis.
FpcPermutationImportance
Result of FPC permutation importance.
FpcShapValues
FPC-level SHAP values for model interpretability.
FriedmanHResult
Result of the Friedman H-statistic for interaction between two FPC components.
FunctionalPdpResult
Result of a functional partial dependence plot.
FunctionalSaliencyResult
Functional saliency map result.
ImportantInterval
An important interval in the function domain.
InfluenceDiagnostics
Cook’s distance and leverage diagnostics for the FPC regression.
LimeResult
Result of a LIME local surrogate explanation.
LooCvResult
Result of leave-one-out cross-validation diagnostics.
PointwiseImportanceResult
Result of pointwise variable importance analysis.
PredictionIntervalResult
Result of prediction interval computation.
PrototypeCriticismResult
Result of prototype/criticism selection.
RegressionDepthResult
Result of regression depth analysis.
SignificantRegion
A contiguous interval where the confidence band excludes zero.
SobolIndicesResult
Sobol first-order and total-order sensitivity indices.
StabilityAnalysisResult
Result of bootstrap stability analysis.
VifResult
Result of VIF analysis for FPC-based regression.

Enums§

DepthType
Type of functional depth measure for regression diagnostics.
SignificanceDirection
Direction of a significant region.

Functions§

anchor_explanation
Anchor explanation for a linear functional regression.
anchor_explanation_logistic
Anchor explanation for a functional logistic regression.
beta_decomposition
Decompose β(t) = Σ_k coef_k × φ_k(t) for a linear functional regression.
beta_decomposition_logistic
Decompose β(t) for a functional logistic regression.
calibration_diagnostics
Calibration diagnostics for a functional logistic regression model.
conditional_permutation_importance
Conditional permutation importance for a linear functional regression model.
conditional_permutation_importance_logistic
Conditional permutation importance for a functional logistic regression model.
conformal_prediction_residuals
Split-conformal prediction intervals for a linear functional regression.
counterfactual_logistic
Counterfactual explanation for a functional logistic regression model (gradient descent).
counterfactual_regression
Counterfactual explanation for a linear functional regression model (analytical).
dfbetas_dffits
DFBETAS and DFFITS for a linear functional regression model.
domain_selection
Domain selection for a linear functional regression model.
domain_selection_logistic
Domain selection for a functional logistic regression model.
expected_calibration_error
Compute expected, maximum, and adaptive calibration errors for a logistic model.
explanation_stability
Bootstrap stability analysis of a linear functional regression.
explanation_stability_logistic
Bootstrap stability analysis of a functional logistic regression.
fpc_ale
ALE plot for an FPC component in a linear functional regression model.
fpc_ale_logistic
ALE plot for an FPC component in a functional logistic regression model.
fpc_permutation_importance
Permutation importance for a linear functional regression (metric = R²).
fpc_permutation_importance_logistic
Permutation importance for functional logistic regression (metric = accuracy).
fpc_shap_values
Exact SHAP values for a linear functional regression model.
fpc_shap_values_logistic
Kernel SHAP values for a functional logistic regression model.
fpc_vif
Variance inflation factors for FPC scores (and optional scalar covariates).
fpc_vif_logistic
VIF for a functional logistic regression model.
friedman_h_statistic
Friedman H-statistic for interaction between two FPC components (linear model).
friedman_h_statistic_logistic
Friedman H-statistic for interaction between two FPC components (logistic model).
functional_pdp
Functional PDP/ICE for a linear functional regression model.
functional_pdp_logistic
Functional PDP/ICE for a functional logistic regression model.
functional_saliency
Functional saliency maps for a linear functional regression model.
functional_saliency_logistic
Functional saliency maps for a functional logistic regression model (gradient-based).
influence_diagnostics
Compute leverage and Cook’s distance for a linear functional regression.
lime_explanation
LIME explanation for a linear functional regression model.
lime_explanation_logistic
LIME explanation for a functional logistic regression model.
loo_cv_press
LOO-CV / PRESS diagnostics for a linear functional regression model.
pointwise_importance
Pointwise variable importance for a linear functional regression model.
pointwise_importance_logistic
Pointwise variable importance for a functional logistic regression model.
prediction_intervals
Prediction intervals for new observations from a linear functional regression model.
prototype_criticism
Select prototypes and criticisms from FPCA scores using MMD-based greedy selection.
regression_depth
Regression depth diagnostics for a linear functional regression.
regression_depth_logistic
Regression depth diagnostics for a functional logistic regression.
significant_regions
Identify contiguous regions where the CI [lower, upper] excludes zero.
significant_regions_from_se
Build CI from β(t) ± z × SE, then find significant regions.
sobol_indices
Exact Sobol sensitivity indices for a linear functional regression model.
sobol_indices_logistic
Sobol sensitivity indices for a functional logistic regression model (Saltelli MC).