Skip to content

utils

flamme.utils

Contain utility functions.

flamme.utils.setup_object

setup_object(obj_or_config: T | dict) -> T

Set up an object from its configuration.

Parameters:

Name Type Description Default
obj_or_config T | dict

The object or its configuration.

required

Returns:

Type Description
T

The instantiated object.

Example usage:

>>> from flamme.utils import setup_object
>>> obj = setup_object({"_target_": "collections.deque", "iterable": [1, 2, 1, 3]})
>>> obj
deque([1, 2, 1, 3])
>>> setup_object(obj)  # Do nothing because the object is already instantiated
deque([1, 2, 1, 3])