MODULE REFERENCE

component

anomx.base.component

Shared metadata for discoverable native algorithms.

Models, scorers, detectors, classifiers, and execution algorithms expose their configuration, capabilities, and signatures here. The platform builds its catalog payloads from this metadata in its own component-catalog helper.

classView source ↗

BaseComponent

BaseComponent

Common metadata surface for installable pipeline components.

Members

component_typeattribute

# BaseComponent.component_type Source ↗

component_type: ClassVar[str | None] = None

component_keyattribute

# BaseComponent.component_key Source ↗

component_key: ClassVar[str] = ''

component_nameattribute

# BaseComponent.component_name Source ↗

component_name: ClassVar[str] = ''

component_descriptionattribute

# BaseComponent.component_description Source ↗

component_description: ClassVar[str] = ''

component_docsattribute

# BaseComponent.component_docs Source ↗

component_docs: ClassVar[str] = ''

component_iconattribute

# BaseComponent.component_icon Source ↗

component_icon: ClassVar[str] = ''

component_image_pathattribute

# BaseComponent.component_image_path Source ↗

component_image_path: ClassVar[str] = ''

component_statusattribute

# BaseComponent.component_status Source ↗

component_status: ClassVar[str] = 'active'

component_discoverableattribute

# BaseComponent.component_discoverable Source ↗

component_discoverable: ClassVar[bool] = True

component_default_configattribute

# BaseComponent.component_default_config Source ↗

component_default_config: ClassVar[dict[str, Any]] = {}

component_config_schemaattribute

# BaseComponent.component_config_schema Source ↗

component_config_schema: ClassVar[dict[str, Any]] = {}

component_code_versionattribute

# BaseComponent.component_code_version Source ↗

component_code_version: ClassVar[str] = ''

signatureattribute

# BaseComponent.signature Source ↗

signature: ClassVar[ModelSignature | None] = None

is_component_abstractclassmethod

# BaseComponent.is_component_abstract Source ↗

is_component_abstract() -> bool

Returns bool

get_component_typeclassmethod

# BaseComponent.get_component_type Source ↗

get_component_type() -> str

Returns str

get_component_keyclassmethod

# BaseComponent.get_component_key Source ↗

get_component_key() -> str

Returns str

get_component_nameclassmethod

# BaseComponent.get_component_name Source ↗

get_component_name() -> str

Returns str

get_component_docsclassmethod

# BaseComponent.get_component_docs Source ↗

get_component_docs() -> str

Returns str

get_component_descriptionclassmethod

# BaseComponent.get_component_description Source ↗

get_component_description() -> str

Returns str

get_component_iconclassmethod

# BaseComponent.get_component_icon Source ↗

get_component_icon() -> str

Returns str

get_component_image_pathclassmethod

# BaseComponent.get_component_image_path Source ↗

get_component_image_path() -> str

Returns str

get_component_statusclassmethod

# BaseComponent.get_component_status Source ↗

get_component_status() -> str

Returns str

get_component_default_configclassmethod

# BaseComponent.get_component_default_config Source ↗

get_component_default_config() -> dict[str, Any]

Returns dict[str, Any]

get_component_config_schemaclassmethod

# BaseComponent.get_component_config_schema Source ↗

get_component_config_schema() -> dict[str, Any]

Returns dict[str, Any]

get_component_code_versionclassmethod

# BaseComponent.get_component_code_version Source ↗

get_component_code_version() -> str

Returns str

get_component_source_pathclassmethod

# BaseComponent.get_component_source_path Source ↗

get_component_source_path() -> str

Returns str

get_component_import_pathclassmethod

# BaseComponent.get_component_import_path Source ↗

get_component_import_path() -> str

Returns str

get_component_capabilitiesclassmethod

# BaseComponent.get_component_capabilities Source ↗

get_component_capabilities() -> list[str]

Returns list[str]

get_component_signatureclassmethod

# BaseComponent.get_component_signature Source ↗

get_component_signature() -> ModelSignature | None

Returns ModelSignature | None

get_component_parametersclassmethod

# BaseComponent.get_component_parameters Source ↗

get_component_parameters() -> list[dict[str, Any]]

Describe the configurable parameters of this component.

The schema and defaults are the source of truth; the __init__ docstring may add per-parameter descriptions later.

Returns list[dict[str, Any]]

get_configmethod

# BaseComponent.get_config Source ↗

get_config() -> dict[str, Any]

Return the effective configuration of this component instance.

Returns dict[str, Any]

functionView source ↗

humanize_component_name

humanize_component_name(value: str | None) -> str

Signature parameters
Parameter	Type	Default
`value`	`str \| None`	`required`

Returns str

functionView source ↗

read_component_source_path

read_component_source_path(component_class: type[object]) -> str

Signature parameters
Parameter	Type	Default
`component_class`	`type[object]`	`required`

Returns str

attributeView source ↗

PROJECT_ROOT

PROJECT_ROOT = Path(__file__).resolve().parents[3]