Index

A

AbstractBBox (class in fairxai.bbox) (class in fairxai.bbox.bbox) add() (fairxai.project.project_registry.ProjectRegistry method)

app_main() (in module fairxai.app.app) ask_choice() (fairxai.explain.explainer_manager.basic_io_handler.BaseIoHandler method) available_frameworks() (fairxai.bbox.bbox_factory.ModelFactory class method)

B

BaseDatasetDescriptor (class in fairxai.data.descriptor.base_descriptor)

BaseIoHandler (class in fairxai.explain.explainer_manager.basic_io_handler) blackbox (fairxai.project.project.Project attribute)

C

categorical_columns (fairxai.data.descriptor.tabular_descriptor.TabularDatasetDescriptor attribute) class_name (fairxai.data.dataset.Dataset attribute) (fairxai.data.dataset.dataset.Dataset attribute) (fairxai.data.dataset.text_dataset.TextDataset attribute) (fairxai.data.dataset.timeserie_dataset.TimeSeriesDataset attribute) clear() (fairxai.project.project_registry.ProjectRegistry method) confirm() (fairxai.explain.explainer_manager.basic_io_handler.BaseIoHandler method)

CounterExampleExplanation (class in fairxai.explain.explaination.counter_example_explanation) CounterfactualRuleExplanation (class in fairxai.explain.explaination.counterfactual_rule_explanation) create() (fairxai.bbox.bbox_factory.ModelFactory class method) (fairxai.data.dataset.dataset_factory.DatasetFactory class method) create_explainer() (fairxai.explain.explainer_manager.explainer_manager.ExplainerManager method) create_project_page() (in module fairxai.app.explainability.create_project_tab) created_at (fairxai.project.project.Project attribute)

D

data (fairxai.data.dataset.Dataset attribute) (fairxai.data.dataset.dataset.Dataset attribute) (fairxai.data.dataset.text_dataset.TextDataset attribute) (fairxai.data.dataset.timeserie_dataset.TimeSeriesDataset attribute) (fairxai.data.descriptor.tabular_descriptor.TabularDatasetDescriptor attribute) Dataset (class in fairxai.data.dataset) (class in fairxai.data.dataset.dataset) dataset_instance (fairxai.project.project.Project attribute) DatasetFactory (class in fairxai.data.dataset.dataset_factory)

describe() (fairxai.data.descriptor.base_descriptor.BaseDatasetDescriptor method) (fairxai.data.descriptor.image_descriptor.ImageDatasetDescriptor method) (fairxai.data.descriptor.tabular_descriptor.TabularDatasetDescriptor method), [1] (fairxai.data.descriptor.text_descriptor.TextDatasetDescriptor method) (fairxai.data.descriptor.timeserie_descriptor.TimeSeriesDatasetDescriptor method) descriptor (fairxai.data.dataset.Dataset attribute) (fairxai.data.dataset.dataset.Dataset attribute) (fairxai.data.dataset.text_dataset.TextDataset attribute) (fairxai.data.dataset.timeserie_dataset.TimeSeriesDataset attribute)

E

ExampleExplanation (class in fairxai.explain.explaination.example_explanation) explain_global() (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter method) explain_instance() (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter method), [1] explainer_name (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter attribute)

ExplainerManager (class in fairxai.explain.explainer_manager.explainer_manager) explainers (fairxai.project.project.Project attribute) explanations (fairxai.project.project.Project attribute)

F

fairxai module fairxai.app module fairxai.app.app module fairxai.app.explainability module fairxai.app.explainability.create_project_tab module fairxai.app.explainability.explainability_page module fairxai.app.explainability.project_tab module fairxai.app.explainability.run_pipeline_tab module fairxai.app.explainability.view_results_tab module fairxai.app.explainability.visualization module fairxai.bbox module fairxai.bbox.bbox module fairxai.bbox.bbox_factory module fairxai.data module fairxai.data.dataset module fairxai.data.dataset.dataset module fairxai.data.dataset.dataset_factory module fairxai.data.dataset.image_dataset module fairxai.data.dataset.tabular_dataset module fairxai.data.dataset.text_dataset module fairxai.data.dataset.timeserie_dataset module fairxai.data.descriptor module fairxai.data.descriptor.base_descriptor module fairxai.data.descriptor.image_descriptor module fairxai.data.descriptor.tabular_descriptor module

fairxai.data.descriptor.text_descriptor module fairxai.data.descriptor.timeserie_descriptor module fairxai.explain module fairxai.explain.adapter module fairxai.explain.adapter.generic_explainer_adapter module fairxai.explain.explaination module fairxai.explain.explaination.counter_example_explanation module fairxai.explain.explaination.counterfactual_rule_explanation module fairxai.explain.explaination.example_explanation module fairxai.explain.explaination.feature_importance_explanation module fairxai.explain.explaination.generic_explanation module fairxai.explain.explaination.rule_based_explanation module fairxai.explain.explainer_manager module fairxai.explain.explainer_manager.basic_io_handler module fairxai.explain.explainer_manager.explainer_manager module fairxai.explain.explainer_manager.guided_explanation_wizard module fairxai.logger module fairxai.main module fairxai.project module fairxai.project.project module fairxai.project.project_registry module FeatureImportanceExplanation (class in fairxai.explain.explaination.feature_importance_explanation) features (fairxai.data.dataset.tabular_dataset.TabularDataset property) (fairxai.data.dataset.TabularDataset property) find_by_name() (fairxai.project.project_registry.ProjectRegistry method) from_dict() (fairxai.data.dataset.image_dataset.ImageDataset class method) (fairxai.data.dataset.tabular_dataset.TabularDataset class method) (fairxai.data.dataset.TabularDataset class method)

G

GenericExplainerAdapter (class in fairxai.explain.adapter.generic_explainer_adapter) GenericExplanation (class in fairxai.explain.explaination.generic_explanation) get() (fairxai.project.project_registry.ProjectRegistry method) get_categorical_columns() (fairxai.data.descriptor.tabular_descriptor.TabularDatasetDescriptor method), [1] get_class() (fairxai.data.dataset.dataset_factory.DatasetFactory class method) get_class_values() (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) get_feature_name() (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) get_feature_names() (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) get_instance() (fairxai.data.dataset.image_dataset.ImageDataset method)

get_metadata() (fairxai.project.project_registry.ProjectRegistry method) get_numeric_columns() (fairxai.data.descriptor.tabular_descriptor.TabularDatasetDescriptor method), [1] get_ordinal_columns() (fairxai.data.descriptor.tabular_descriptor.TabularDatasetDescriptor method), [1] get_project_path() (fairxai.project.project_registry.ProjectRegistry method) GLOBAL_EXPLANATION (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter attribute) (fairxai.explain.explaination.counter_example_explanation.CounterExampleExplanation attribute) (fairxai.explain.explaination.counterfactual_rule_explanation.CounterfactualRuleExplanation attribute) (fairxai.explain.explaination.example_explanation.ExampleExplanation attribute) (fairxai.explain.explaination.feature_importance_explanation.FeatureImportanceExplanation attribute) (fairxai.explain.explaination.generic_explanation.GenericExplanation attribute) (fairxai.explain.explaination.rule_based_explanation.RuleBasedExplanation attribute) GuidedExplanationWizard (class in fairxai.explain.explainer_manager.guided_explanation_wizard)

I

id (fairxai.project.project.Project attribute) ImageDataset (class in fairxai.data.dataset.image_dataset)

ImageDatasetDescriptor (class in fairxai.data.descriptor.image_descriptor) import_all_adapters() (in module fairxai.explain.explainer_manager.explainer_manager) is_compatible() (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter class method)

L

list_all() (fairxai.project.project_registry.ProjectRegistry method) list_available_compatible_explainers() (fairxai.explain.explainer_manager.explainer_manager.ExplainerManager method) load_from_dict() (fairxai.project.project.Project class method) load_project() (fairxai.project.project_registry.ProjectRegistry method) LOCAL_EXPLANATION (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter attribute) (fairxai.explain.explaination.counter_example_explanation.CounterExampleExplanation attribute) (fairxai.explain.explaination.counterfactual_rule_explanation.CounterfactualRuleExplanation attribute) (fairxai.explain.explaination.example_explanation.ExampleExplanation attribute) (fairxai.explain.explaination.feature_importance_explanation.FeatureImportanceExplanation attribute) (fairxai.explain.explaination.generic_explanation.GenericExplanation attribute) (fairxai.explain.explaination.rule_based_explanation.RuleBasedExplanation attribute)

M

main() (in module fairxai.main) model() (fairxai.bbox.AbstractBBox method) (fairxai.bbox.bbox.AbstractBBox method) ModelFactory (class in fairxai.bbox.bbox_factory) module fairxai fairxai.app fairxai.app.app fairxai.app.explainability fairxai.app.explainability.create_project_tab fairxai.app.explainability.explainability_page fairxai.app.explainability.project_tab fairxai.app.explainability.run_pipeline_tab fairxai.app.explainability.view_results_tab fairxai.app.explainability.visualization fairxai.bbox fairxai.bbox.bbox fairxai.bbox.bbox_factory fairxai.data fairxai.data.dataset fairxai.data.dataset.dataset fairxai.data.dataset.dataset_factory fairxai.data.dataset.image_dataset fairxai.data.dataset.tabular_dataset fairxai.data.dataset.text_dataset fairxai.data.dataset.timeserie_dataset fairxai.data.descriptor fairxai.data.descriptor.base_descriptor fairxai.data.descriptor.image_descriptor fairxai.data.descriptor.tabular_descriptor fairxai.data.descriptor.text_descriptor fairxai.data.descriptor.timeserie_descriptor fairxai.explain fairxai.explain.adapter fairxai.explain.adapter.generic_explainer_adapter fairxai.explain.explaination fairxai.explain.explaination.counter_example_explanation fairxai.explain.explaination.counterfactual_rule_explanation fairxai.explain.explaination.example_explanation fairxai.explain.explaination.feature_importance_explanation fairxai.explain.explaination.generic_explanation fairxai.explain.explaination.rule_based_explanation fairxai.explain.explainer_manager fairxai.explain.explainer_manager.basic_io_handler fairxai.explain.explainer_manager.explainer_manager fairxai.explain.explainer_manager.guided_explanation_wizard fairxai.logger fairxai.main fairxai.project fairxai.project.project fairxai.project.project_registry

O

ordinal_columns (fairxai.data.descriptor.tabular_descriptor.TabularDatasetDescriptor attribute)

P

predict() (fairxai.bbox.AbstractBBox method) (fairxai.bbox.bbox.AbstractBBox method) predict_proba() (fairxai.bbox.AbstractBBox method) (fairxai.bbox.bbox.AbstractBBox method)

Project (class in fairxai.project.project) ProjectRegistry (class in fairxai.project.project_registry) projects_page() (in module fairxai.app.explainability.project_tab)

R

register_framework() (fairxai.bbox.bbox_factory.ModelFactory class method) remove() (fairxai.project.project_registry.ProjectRegistry method) results_page() (in module fairxai.app.explainability.view_results_tab) RuleBasedExplanation (class in fairxai.explain.explaination.rule_based_explanation)

run() (fairxai.explain.explainer_manager.guided_explanation_wizard.GuidedExplanationWizard method) run_explanation_pipeline() (fairxai.project.project.Project method) run_pipeline_from_yaml() (fairxai.project.project.Project method) run_pipeline_page() (in module fairxai.app.explainability.run_pipeline_tab)

S

save_memory_data() (fairxai.data.dataset.image_dataset.ImageDataset method) (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) set_class_name() (fairxai.data.dataset.Dataset method) (fairxai.data.dataset.dataset.Dataset method) (fairxai.data.dataset.image_dataset.ImageDataset method) (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) (fairxai.data.dataset.text_dataset.TextDataset method) (fairxai.data.dataset.timeserie_dataset.TimeSeriesDataset method) set_descriptor() (fairxai.data.dataset.Dataset method) (fairxai.data.dataset.dataset.Dataset method) (fairxai.data.dataset.image_dataset.ImageDataset method) (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) (fairxai.data.dataset.text_dataset.TextDataset method) (fairxai.data.dataset.timeserie_dataset.TimeSeriesDataset method)

show() (in module fairxai.app.explainability.explainability_page) show_message() (fairxai.explain.explainer_manager.basic_io_handler.BaseIoHandler method) supported_datasets (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter attribute) supported_models (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter attribute)

T

TabularDataset (class in fairxai.data.dataset) (class in fairxai.data.dataset.tabular_dataset) TabularDatasetDescriptor (class in fairxai.data.descriptor.tabular_descriptor) target (fairxai.data.dataset.Dataset attribute) (fairxai.data.dataset.dataset.Dataset attribute) (fairxai.data.dataset.tabular_dataset.TabularDataset property) (fairxai.data.dataset.TabularDataset property) TextDataset (class in fairxai.data.dataset.text_dataset) TextDatasetDescriptor (class in fairxai.data.descriptor.text_descriptor) TimeSeriesDataset (class in fairxai.data.dataset.timeserie_dataset)

TimeSeriesDatasetDescriptor (class in fairxai.data.descriptor.timeserie_descriptor) to_dict() (fairxai.data.dataset.image_dataset.ImageDataset method) (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) (fairxai.explain.explaination.counter_example_explanation.CounterExampleExplanation method) (fairxai.explain.explaination.counterfactual_rule_explanation.CounterfactualRuleExplanation method) (fairxai.explain.explaination.example_explanation.ExampleExplanation method) (fairxai.explain.explaination.feature_importance_explanation.FeatureImportanceExplanation method) (fairxai.explain.explaination.generic_explanation.GenericExplanation method) (fairxai.explain.explaination.rule_based_explanation.RuleBasedExplanation method) (fairxai.project.project.Project method)

U

update_descriptor() (fairxai.data.dataset.Dataset method) (fairxai.data.dataset.dataset.Dataset method) (fairxai.data.dataset.image_dataset.ImageDataset method) (fairxai.data.dataset.tabular_dataset.TabularDataset method) (fairxai.data.dataset.TabularDataset method) (fairxai.data.dataset.text_dataset.TextDataset method), [1] (fairxai.data.dataset.timeserie_dataset.TimeSeriesDataset method), [1]

V

visualize() (fairxai.explain.explaination.counter_example_explanation.CounterExampleExplanation method) (fairxai.explain.explaination.counterfactual_rule_explanation.CounterfactualRuleExplanation method) (fairxai.explain.explaination.example_explanation.ExampleExplanation method) (fairxai.explain.explaination.feature_importance_explanation.FeatureImportanceExplanation method) (fairxai.explain.explaination.generic_explanation.GenericExplanation method) (fairxai.explain.explaination.rule_based_explanation.RuleBasedExplanation method)

visualize_explanation() (in module fairxai.app.explainability.visualization)

W

WILDCARD (fairxai.explain.adapter.generic_explainer_adapter.GenericExplainerAdapter attribute)

X

X (fairxai.data.dataset.tabular_dataset.TabularDataset property) (fairxai.data.dataset.TabularDataset property)

Y

y (fairxai.data.dataset.tabular_dataset.TabularDataset property) (fairxai.data.dataset.TabularDataset property)