Skip to content

rpn_config

Bases: config

The configuration class of RPN model.

It implements the configuration class for the RPN model specifically. The class can help instantiate the RPN model from its configuration file.

Attributes:

Name Type Description
name str, default = 'rpn_config'

Name of the rpn_config object.

Methods:

Name Description
__init__

The rpn_config initialization method.
instantiate_object_from_config

The rpn objects instantiation method from the configuration.
extract_config_from_object

The rpn configuration extraction method from the rpn objects.
Source code in tinybig/config/rpn_config.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 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
class rpn_config(config):
    """
    The configuration class of RPN model.

    It implements the configuration class for the RPN model specifically.
    The class can help instantiate the RPN model from its configuration file.

    Attributes
    ----------
    name: str, default = 'rpn_config'
        Name of the rpn_config object.

    Methods
    ----------

    __init__
        The rpn_config initialization method.

    instantiate_object_from_config
        The rpn objects instantiation method from the configuration.

    extract_config_from_object
        The rpn configuration extraction method from the rpn objects.
    """
    def __init__(self, name='rpn_config'):
        """
        The rpn config initialization method.

        It initializes the rpn config object based on the provided parameters.

        Parameters
        ----------
        name: str, default = 'rpn_config'
            Name of the rpn configuration object.
        """
        super().__init__(name=name)

    @staticmethod
    def instantiate_object_from_config(configs: dict):
        """
        The rpn object instantiation method from the configuration.

        It initializes a rpn object from its detailed configuration information.

        Parameters
        ----------
        configs: dict
            The rpn object detailed configuration.

        Returns
        -------
        dict
            The initialized object dictionary based on the configs.
        """
        object_dict = {}
        for config in configs:
            if '_configs' not in config: continue
            object_name_stem = config.split('_configs')[0]
            if "{}_class".format(object_name_stem) in configs[config]:
                class_name = configs[config]["{}_class".format(object_name_stem)]
                parameters = configs[config]["{}_parameters".format(object_name_stem)]
                obj = get_obj_from_str(class_name)(**parameters)
            else:
                obj = None
            object_dict[object_name_stem] = obj
        return object_dict

    @staticmethod
    def extract_config_from_object(objects, *args, **kwargs):
        """
        The rpn configuration extraction method from the rpn objects.

        It extracts the rpn object configuration and return it as a confi dictionary.

        Parameters
        ----------
        objects: object
            The rpn model and component object.

        Returns
        -------
        dict
            The configuration information of the input object.
        """
        pass

__init__(name='rpn_config')

The rpn config initialization method.

It initializes the rpn config object based on the provided parameters.

Parameters:

Name Type Description Default
name

Name of the rpn configuration object.

 'rpn_config'
Source code in tinybig/config/rpn_config.py 
40
41
42
43
44
45
46
47
48
49
50
51
def __init__(self, name='rpn_config'):
    """
    The rpn config initialization method.

    It initializes the rpn config object based on the provided parameters.

    Parameters
    ----------
    name: str, default = 'rpn_config'
        Name of the rpn configuration object.
    """
    super().__init__(name=name)

extract_config_from_object(objects, *args, **kwargs) staticmethod

The rpn configuration extraction method from the rpn objects.

It extracts the rpn object configuration and return it as a confi dictionary.

Parameters:

Name Type Description Default
objects

The rpn model and component object.

 required

Returns:

Type Description
dict

The configuration information of the input object.
Source code in tinybig/config/rpn_config.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@staticmethod
def extract_config_from_object(objects, *args, **kwargs):
    """
    The rpn configuration extraction method from the rpn objects.

    It extracts the rpn object configuration and return it as a confi dictionary.

    Parameters
    ----------
    objects: object
        The rpn model and component object.

    Returns
    -------
    dict
        The configuration information of the input object.
    """
    pass

instantiate_object_from_config(configs) staticmethod

The rpn object instantiation method from the configuration.

It initializes a rpn object from its detailed configuration information.

Parameters:

Name Type Description Default
configs dict

The rpn object detailed configuration.

 required

Returns:

Type Description
dict

The initialized object dictionary based on the configs.
Source code in tinybig/config/rpn_config.py 
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
@staticmethod
def instantiate_object_from_config(configs: dict):
    """
    The rpn object instantiation method from the configuration.

    It initializes a rpn object from its detailed configuration information.

    Parameters
    ----------
    configs: dict
        The rpn object detailed configuration.

    Returns
    -------
    dict
        The initialized object dictionary based on the configs.
    """
    object_dict = {}
    for config in configs:
        if '_configs' not in config: continue
        object_name_stem = config.split('_configs')[0]
        if "{}_class".format(object_name_stem) in configs[config]:
            class_name = configs[config]["{}_class".format(object_name_stem)]
            parameters = configs[config]["{}_parameters".format(object_name_stem)]
            obj = get_obj_from_str(class_name)(**parameters)
        else:
            obj = None
        object_dict[object_name_stem] = obj
    return object_dict