Skip to content

Registry Info

RegistryInfo reports which components are currently registered. Each method logs the registered IDs and returns them as a list — useful for confirming a custom component's module was imported.

luna_bench.custom.registry_info.RegistryInfo

Provides utility functions to log and retrieve information from the registries.

log_registry_contents(feature_registry: Registry[BaseFeature] = Provide[RegistryContainer.feature_registry], algorithm_sync_registry: Registry[BaseAlgorithmSync] = Provide[RegistryContainer.algorithm_sync_registry], algorithm_async_registry: Registry[BaseAlgorithmAsync[BaseModel]] = Provide[RegistryContainer.algorithm_async_registry], metric_registry: Registry[BaseMetric] = Provide[RegistryContainer.metric_registry], plot_registry: Registry[BasePlot] = Provide[RegistryContainer.plot_registry]) -> None staticmethod

Print information about the registered features, algorithms, metrics, and plots.

Parameters:

  • feature_registry (Registry[BaseFeature], default: Provide[feature_registry] ) –
  • algorithm_sync_registry (Registry[BaseAlgorithmSync], default: Provide[algorithm_sync_registry] ) –
  • algorithm_async_registry (Registry[BaseAlgorithmAsync[BaseModel]], default: Provide[algorithm_async_registry] ) –
  • metric_registry (Registry[BaseMetric], default: Provide[metric_registry] ) –
  • plot_registry (Registry[BasePlot], default: Provide[plot_registry] ) –

log_registered_features(feature_registry: Registry[BaseFeature] = Provide[RegistryContainer.feature_registry]) -> list[str] staticmethod

Retrieve the feature registry.

Parameters:

  • feature_registry (Registry[BaseFeature], default: Provide[feature_registry] ) –

Returns:

  • Registry[BaseFeature] –

    Returns the injected feature registry.

log_registered_sync(algorithm_registry: Registry[BaseAlgorithmSync] = Provide[RegistryContainer.algorithm_sync_registry]) -> list[str] staticmethod

Retrieve the algorithm registry.

Parameters:

  • algorithm_registry (Registry[BaseAlgorithmSync], default: Provide[algorithm_sync_registry] ) –

Returns:

  • Registry[IAlgorithm[IBackend]] –

    Returns the injected algorithm registry.

log_registered_algorithms_async(algorithm_registry: Registry[BaseAlgorithmAsync[BaseModel]] = Provide[RegistryContainer.algorithm_async_registry]) -> list[str] staticmethod

Retrieve the algorithm registry.

Parameters:

  • algorithm_registry (Registry[BaseAlgorithmAsync[BaseModel]], default: Provide[algorithm_async_registry] ) –

Returns:

  • Registry[IAlgorithm[IBackend]] –

    Returns the injected algorithm registry.

log_registered_metrics(metric_registry: Registry[BaseMetric] = Provide[RegistryContainer.metric_registry]) -> list[str] staticmethod

Retrieve the metric registry.

Parameters:

  • metric_registry (Registry[BaseMetric], default: Provide[metric_registry] ) –

Returns:

  • Registry[BaseMetric] –

    Returns the injected metric registry.

log_registered_plots(plot_registry: Registry[BasePlot] = Provide[RegistryContainer.plot_registry]) -> list[str] staticmethod

Retrieve the plot registry.

Parameters:

  • plot_registry (Registry[BasePlot], default: Provide[plot_registry] ) –

Returns:

  • Registry[BasePlot] –

    Returns the injected plot registry.

get_feature_by_id(registered_id: str, feature_registry: Registry[BaseFeature] = Provide[RegistryContainer.feature_registry]) -> type[BaseFeature] staticmethod

Look up a registered feature class by its id.

Used when a stored configuration references a feature class, which cannot be persisted as such, e.g. the grouping feature of a bar plot.

Parameters:

  • registered_id (str) –

    The id the feature was registered under.

  • feature_registry (Registry[BaseFeature], default: Provide[feature_registry] ) –

Returns:

Raises:

  • UnknownIdError –

    If no feature is registered under that id.