palma.components.dashboard

Module Contents

Classes

ExplainerDashboard

Attributes

default_config_path

palma.components.dashboard.default_config_path

class palma.components.dashboard.ExplainerDashboard(dashboard_config: str | Dict = default_config_path, n_sample: int = None)

Bases: palma.components.base.Component

__call__(project: Project, model: Model) → explainerdashboard.ExplainerDashboard

This function returns dashboard instance. This dashboard is to be run using its run method.

Parameters:

project: Project

Instance of project used to compute explainer.

model: Run

Current run to use in explainer.

Examples

>>> db = ExpDash(dashboard_config="path_to_my_config")
>>> explainer_dashboard = db(project, model)
>>> explainer_dashboard.run(
>>>    port="8050", host="0.0.0.0", use_waitress=False)

update_config(dict_value: Dict[str, Dict])

Update specific parameters from the actual configuration.

Parameters:

dict_value: dict

explainer_parameters: dict

Parameters to be used in see explainerdashboard.RegressionExplainer or explainerdashboard.ClassifierExplainer.

dashboard_parameters: dict

Parameters use to compose dashboard tab, items or themes for explainerdashboard.ExplainerDashboard. Tabs and component of the dashboard can be hidden, see customize dashboard section for more detail.

_prepare_dataset() → None

This function performs the following processing steps :

• Ensure that column name is str (bug encountered in dashboard)

• Get code from categories just in case of category data types

• Sample the data if specified by user

_get_explainer(project: Project, model: Model) → explainerdashboard.explainers.BaseExplainer

_get_dashboard(explainer: explainerdashboard.explainers.BaseExplainer) → ExplainerDashboard