Registry¶
ConfigRegistry
¶
Bases: Registry
ConfigRegistry
for components that can be initialised with a config
.
ConfigRegistry
is particularly useful when you want to construct a component from a configuration, such as a
Hugginface Transformers model.
See Also
Registry
: General purpose Registry.
Examples:
>>> from dataclasses import dataclass, field
>>> @dataclass
... class Config:
... a: int
... b: int
... mode: str = "proj"
>>> registry = ConfigRegistry(key="mode")
>>> @registry.register("proj")
... class Proj:
... def __init__(self, config):
... self.a = config.a
... self.b = config.b
>>> @registry.register("inv")
... class Inv:
... def __init__(self, config):
... self.a = config.b
... self.b = config.a
>>> registry
ConfigRegistry(
('proj'): <class 'chanfig.registry.Proj'>
('inv'): <class 'chanfig.registry.Inv'>
)
>>> config = Config(a=0, b=1)
>>> module = registry.build(config)
>>> module.a, module.b
(0, 1)
>>> config = Config(a=0, b=1, mode="inv")
>>> module = registry.build(config)
>>> module.a, module.b
(1, 0)
>>> @dataclass
... class ModuleConfig:
... a: int = 0
... b: int = 1
... mode: str = "proj"
>>> @dataclass
... class NestedConfig:
... module: ModuleConfig = field(default_factory=ModuleConfig)
>>> nested_registry = ConfigRegistry(key="module.mode")
>>> @nested_registry.register("proj")
... class Proj:
... def __init__(self, config):
... self.a = config.module.a
... self.b = config.module.b
>>> @nested_registry.register("inv")
... class Inv:
... def __init__(self, config):
... self.a = config.module.b
... self.b = config.module.a
>>> nested_config = NestedConfig()
>>> module = nested_registry.build(nested_config)
>>> module.a, module.b
(0, 1)
Source code in chanfig/registry.py
Python | |
---|---|
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 |
|
build(config, *args, **kwargs)
¶
Build a component.
Returns:
Type | Description |
---|---|
Any
|
|
Raises:
Type | Description |
---|---|
KeyError
|
If the component is not registered. |
Examples:
>>> from dataclasses import dataclass, field
>>> registry = ConfigRegistry(key="module.mode")
>>> @registry.register("proj")
... class Proj:
... def __init__(self, config):
... self.a = config.module.a
... self.b = config.module.b
>>> @registry.register("inv")
... class Inv:
... def __init__(self, config):
... self.a = config.module.b
... self.b = config.module.a
>>> @dataclass
... class ModuleConfig:
... a: int = 0
... b: int = 1
... mode: str = "proj"
>>> @dataclass
... class Config:
... module: ModuleConfig = field(default_factory=ModuleConfig)
>>> config = Config()
>>> module = registry.build(config)
>>> type(module)
<class 'chanfig.registry.Proj'>
>>> module.a, module.b
(0, 1)
>>> type(module)
<class 'chanfig.registry.Proj'>
Source code in chanfig/registry.py
init(config, *args, **kwargs)
staticmethod
¶
Constructor of component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cls |
Callable
|
The component to construct. |
required |
*args |
Any
|
The arguments to pass to the component. |
()
|
**kwargs |
Any
|
The keyword arguments to pass to the component. |
{}
|
Returns:
Type | Description |
---|---|
Any
|
|
Examples:
>>> class Module:
... def __init__(self, config, a=None, b=None):
... self.config = config
... self.a = config.a if a is None else a
... self.b = config.b if b is None else b
>>> config = NestedDict({"a": 0, "b": 1})
>>> module = ConfigRegistry.init(Module, config, b=2)
>>> module.a, module.b
(0, 2)
Source code in chanfig/registry.py
Registry
¶
Bases: NestedDict
Registry
for components.
Registry
provides 3 core functionalities:
- Register a new component.
- Lookup for a component.
- Build a component.
To facilitate the usage scenario, registry
is designed to be a decorator.
You could register a component by simply calling registry.register
, and it will be registered with its name.
You may also specify the name of the component by calling registry.register(name="ComponentName")
.
build
makes it easy to construct a component from a configuration.
build
automatically determines the component to construct by the name
field in the configuration.
So you could either call registry.build(config)
or registry.build(**config)
.
Beyond this, build
is just a syntax sugar for registry.init(registry.lookup(name), *args, **kwargs)
.
lookup
is used to lookup for a component by its name.
By default, lookup
internally calls NestedDict.get
, but you may override it to provide more functionalities.
init
is used to construct a component.
By default, init
internally calls cls(*args, **kwargs)
, but you may override it to provide more functionalities.
Notes
Registry
inherits from NestedDict
.
Therefore, Registry
comes in a nested structure by nature.
You could create a sub-registry by simply calling registry.sub_registry = Registry
,
and access through registry.sub_registry.register()
.
See Also
ConfigRegistry
: Optimised for components that can be initialised with a config
.
Examples:
>>> registry = Registry()
>>> @registry.register
... @registry.register("Module1", default=True)
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> module = registry.register(Module, "Module2")
>>> registry
Registry(
('Module1'): <class 'chanfig.registry.Module'>
('Module'): <class 'chanfig.registry.Module'>
('Module2'): <class 'chanfig.registry.Module'>
)
>>> module = registry.register(Module, "Module")
Traceback (most recent call last):
ValueError: Component with name Module already registered.
>>> registry.lookup("Module")
<class 'chanfig.registry.Module'>
>>> config = {"module": {"name": "Module", "a": 0, "b": 1}}
>>> # registry.register(Module)
>>> module = registry.build(config["module"])
>>> type(module)
<class 'chanfig.registry.Module'>
>>> module.a, module.b
(0, 1)
>>> config = {"module": {"name": "NE", "a": 1, "b": 0}}
>>> module = registry.build(config["module"])
>>> module.a, module.b
(1, 0)
Source code in chanfig/registry.py
Python | |
---|---|
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
|
build(name=Null, *args, **kwargs)
¶
Build a component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str | MutableMapping
|
If its a |
Null
|
*args |
Any
|
The arguments to pass to the component. |
()
|
**kwargs |
Any
|
The keyword arguments to pass to the component. |
{}
|
Returns:
Type | Description |
---|---|
Any
|
|
Raises:
Type | Description |
---|---|
KeyError
|
If the component is not registered. |
Examples:
>>> registry = Registry(key="model")
>>> @registry.register
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> config = {"module": {"model": "Module", "a": 1, "b": 2}}
>>> # registry.register(Module)
>>> module = registry.build(**config["module"])
>>> type(module)
<class 'chanfig.registry.Module'>
>>> module.a
1
>>> module.b
2
>>> module = registry.build(config["module"], a=2)
>>> module.a
2
Source code in chanfig/registry.py
init(*args, **kwargs)
staticmethod
¶
Constructor of component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
cls |
Callable
|
The component to construct. |
required |
*args |
Any
|
The arguments to pass to the component. |
()
|
**kwargs |
Any
|
The keyword arguments to pass to the component. |
{}
|
Returns:
Type | Description |
---|---|
Any
|
|
Examples:
>>> class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> kwargs = {"a": 0, "b": 1}
>>> module = Registry.init(Module, **kwargs)
>>> type(module)
<class 'chanfig.registry.Module'>
>>> module.a, module.b
(0, 1)
Source code in chanfig/registry.py
lookup(name, default=Null)
¶
Lookup for a component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
str
|
|
required |
Returns:
Type | Description |
---|---|
Any
|
The component. |
Raises:
Type | Description |
---|---|
KeyError
|
If the component is not registered. |
Examples:
>>> registry = Registry()
>>> @registry.register
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> registry.lookup("Module")
<class 'chanfig.registry.Module'>
Source code in chanfig/registry.py
register(component=Null, name=Null, override=False, default=False)
¶
Register a new component.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
component |
Any
|
The component to register. |
Null
|
name |
Any
|
The name of the component. |
Null
|
Returns:
Name | Type | Description |
---|---|---|
component |
Callable
|
The registered component.
Registered component are expected to be |
Raises:
Type | Description |
---|---|
ValueError
|
If the component with the same name already registered and |
Examples:
>>> registry = Registry()
>>> @registry.register
... @registry.register("Module1")
... class Module:
... def __init__(self, a, b):
... self.a = a
... self.b = b
>>> module = registry.register(Module, "Module2")
>>> registry
Registry(
('Module1'): <class 'chanfig.registry.Module'>
('Module'): <class 'chanfig.registry.Module'>
('Module2'): <class 'chanfig.registry.Module'>
)