# registry

Python API: `luxonis_ml.utils.registry`

## Classes

| Name | Description |
| --- | --- |
|
[`AutoRegisterMeta`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md)
| Metaclass for automatically registering modules. |
|
[`Registry`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md)
| A registry to store and retrieve modules. |

### class `AutoRegisterMeta`

```python
class AutoRegisterMeta(ABCMeta)
```

Metaclass for automatically registering modules.

Can be set as a metaclass for abstract base classes. All subclasses of that class will be automatically registered.

> **Example**
> ```pycon
>>> REGISTRY = Registry(name="modules")
>>> class Base(
...     metaclass=AutoRegisterMeta,
...     registry=REGISTRY,
...     register=False,
... ):
...     pass
>>> class Foo(Base):
...     pass
>>> class Bar(Base, register_name="Baz"):
...     pass
>>> REGISTRY.get("Foo").__name__
'Foo'
>>> Base.REGISTRY.get("Baz").__name__
'Bar'
```

Attributes

| Name | Type | Description |
| --- | --- | --- |
| `REGISTRY` | `Registry` | The internal registry defined on the base class. |

### class `Registry`

```python
class Registry(Generic)
```

A registry to store and retrieve modules.

The registry stores a mapping from string keys to module classes. It provides an interface to register modules and later retrieve them by their string names.

Properties

| Name | Type | Description |
| --- | --- | --- |
| [`name`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md) | `str` | The name of the registry. |

Methods

| Name | Description |
| --- | --- |
| [`__init__`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md) | Create a new empty registry. |
| [`get`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md) | Retrieve the registry record for the key. |
| [`register`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md) | Register a module. |
| [`register_module`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md) | Register a module. Deprecated, use [register](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md) instead. |

#### property `name`

```python
name: str
```

The name of the registry.

#### method `__init__`

```python
def __init__(name: str)
```

Create a new empty registry.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `name` | `str` | The name of the registry, used for error messages. | required |

#### method `get`

```python
def get(key: str) -> T
```

Retrieve the registry record for the key.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `key` | `str` | The name of the registered item. | required |

Returns

| Type | Description |
| --- | --- |
| `T` | The registered item corresponding to the key. |

Raises

| Type | Description |
| --- | --- |
| `KeyError` | If the key is not found in the registry. |

#### method `register`

```python
def register(
    module: T | None = None,
    *,
    name: str | None = None,
    force: bool = False,
) -> Callable[[T], T] | None
```

Register a module.

Can be used as a decorator or as a normal method:

> **Example**
> ```pycon
>>> registry = Registry(name="modules")
>>> @registry.register()
... class Foo:
...     pass
>>> registry.get("Foo").__name__
'Foo'
>>> class Bar:
...     pass
>>> registry.register(module=Bar)
>>> registry.get("Bar").__name__
'Bar'
```

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `module` | `T | None` | The module class to be registered. | `None` |
| `name` | `str | None` | The name of the module. If `None`, then use class name. | `None` |
| `force` | `bool` | Whether to override an existing class with the same name. | `False` |

Returns

| Type | Description |
| --- | --- |
| `Callable[[T], T] | None` | `None` if used as a normal method, or a decorator function if used as a decorator. |

Raises

| Type | Description |
| --- | --- |
| `KeyError` | If a module with the same name already exists and `force` is `False`. |

#### method `register_module`

```python
def register_module(
    name: str | None = None,
    module: T | None = None,
    force: bool = False,
) -> T | Callable[[T], T]
```

Register a module. Deprecated, use
[register](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md)
instead.

> **Deprecated**
> Deprecated since version 0.6.0:Use [register](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md) instead.

Args

| Name | Type | Description | Default |
| --- | --- | --- | --- |
| `name` | `str | None` | Name of the module. If `None`, the class name is used. | `None` |
| `module` | `T | None` | Module class to be registered. | `None` |
| `force` | `bool` | Whether to override an existing class with the same name. | `False` |

Returns

| Type | Description |
| --- | --- |
| `T | Callable[[T], T]` | Registered module or decorator returned by
[register](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md).
|

Raises

| Type | Description |
| --- | --- |
| `KeyError` | If a module with the same name already exists and `force` is `False`. |

## Module Attributes

| Name | Description |
| --- | --- |
|
[`T`](https://docs.luxonis.com/software-v3/ai-inference/model-source/training/luxonis-ml/luxonis-ml-api-reference/utils/registry.md)
| |

### type variable `T`

```python
T = TypeVar('T', bound=type)
```
