Skip to main content

ResidualHistogram

Report
DashAI.back.reports.regression.ResidualHistogram

Distribution of the residuals, with the zero line marked.

Shows the shape of the error rather than its magnitude. Residuals should centre on zero and fall away symmetrically; a shifted centre means constant bias, a long tail on one side means the model fails asymmetrically, and two peaks usually mean a subpopulation the model treats as one group.

Parameters

bins : integer, default=30
Number of bins used to bucket the residuals.

Methods

compute(self, y_true, y_pred, class_names: Optional[List[str]] = None) -> List[DashAI.back.core.artifacts.Artifact]

Defined on ResidualHistogram

Build the residual histogram.

Parameters

y_true : ndarray
Ground truth values.
y_pred : ndarray
Model predictions.
class_names : Optional[List[str]]
Unused; always None for regression.

Returns

List[Artifact]
A single histogram figure with a zero reference line.

get_credential(self, name: str)

Defined on ConfigObject

Resolve a registered credential component by name.

Parameters

name : str
Credential component class name (e.g. "HuggingFaceCredential").

Returns

BaseCredential
An instance of the requested credential component.

get_metadata(cls) -> Dict[str, Any]

Defined on BaseReport

Get metadata values for the current report.

Returns

Dict[str, Any]
UI metadata, including whether the report needs a model that outputs class probabilities.

get_schema(cls) -> dict

Defined on ConfigObject

Generates the component related Json Schema.

Returns

dict
Dictionary representing the Json Schema of the component.

validate_and_transform(self, raw_data: dict) -> dict

Defined on ConfigObject

It takes the data given by the user to initialize the model and returns it with all the objects that the model needs to work.

Parameters

raw_data : dict
A dictionary with the data provided by the user to initialize the model.

Returns

dict
A validated dictionary with the necessary objects.

Compatible with