MODULE REFERENCE
scorers
anomx.detection.base.scorersScorer taxonomy.
Scorers convert model output into continuous anomaly scores. The family bases express *where the score comes from*; concrete implementations subclass the family that matches their mechanism:
` Scorer ├── ResidualScorer forecast / prediction errors ├── ReconstructionScorer reconstruction errors ├── RepresentationScorer latent-space distances ├── LikelihoodScorer negative log likelihoods ├── BoundaryScorer signed boundary distances ├── DirectDataScorer scores computed on the raw data itself └── CompositeScorer combinations of child scorers `
classView source ↗
BoundaryScorer
BoundaryScorerBases: Scorer, ABC
Score anomalies from distances to a learned normality boundary.
Members
scorer_familyattribute
scorer_family = 'boundary'Inherited members
scoreScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentclassView source ↗
CompositeScorer
CompositeScorer(scorers: list[Scorer] | None = None, config: dict[str, Any] | None = None)Bases: Scorer
Combine the scores of several child scorers into one score column.
| Parameter | Type | Default |
|---|---|---|
scorers | list[Scorer] | None | None |
config | dict[str, Any] | None | None |
Members
scorer_familyattribute
scorer_family = 'composite'component_statusattribute
component_status = 'disabled'scoremethod
score(data: Any) -> Any| Parameter | Type | Default |
|---|---|---|
data | Any | required |
Returns Any
Inherited members
is_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentclassView source ↗
DirectDataScorer
DirectDataScorerBases: Scorer, ABC
Score anomalies directly on the observations without a model output.
Members
scorer_familyattribute
scorer_family = 'direct_data'Inherited members
scoreScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentclassView source ↗
LikelihoodScorer
LikelihoodScorerBases: Scorer, ABC
Score anomalies from estimated likelihoods.
Members
scorer_familyattribute
scorer_family = 'likelihood'Inherited members
scoreScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentclassView source ↗
ReconstructionScorer
ReconstructionScorerBases: Scorer, ABC
Score anomalies from reconstruction errors.
Members
scorer_familyattribute
scorer_family = 'reconstruction'Inherited members
scoreScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentclassView source ↗
RepresentationScorer
RepresentationScorerBases: Scorer, ABC
Score anomalies from latent-space distances or densities.
Members
scorer_familyattribute
scorer_family = 'representation'Inherited members
scoreScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentclassView source ↗
ResidualScorer
ResidualScorerBases: Scorer, ABC
Score anomalies from prediction or forecast residuals.
Members
scorer_familyattribute
scorer_family = 'residual'Inherited members
scoreScoreris_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponentclassView source ↗
Scorer
ScorerBases: BaseComponent, ABC
Convert model outputs into standardized anomaly scores.
Members
component_typeattribute
component_type = 'scorer'scorer_familyattribute
scorer_family: ClassVar[str] = ''capabilitiesattribute
capabilities: ClassVar[ComponentCapabilities] = ComponentCapabilities(requires_training=False)scoremethod
score(data: Any) -> AnyReturn scored prediction records.
| Parameter | Type | Default |
|---|---|---|
data | Any | required |
Returns Any
Inherited members
is_component_abstractBaseComponentget_component_typeBaseComponentget_component_keyBaseComponentget_component_nameBaseComponentget_component_docsBaseComponentget_component_descriptionBaseComponentget_component_iconBaseComponentget_component_image_pathBaseComponentget_component_statusBaseComponentget_component_default_configBaseComponentget_component_config_schemaBaseComponentget_component_code_versionBaseComponentget_component_source_pathBaseComponentget_component_import_pathBaseComponentget_component_capabilitiesBaseComponentget_component_signatureBaseComponentget_component_parametersBaseComponentget_configBaseComponent