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/model_config.py 
 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class model_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,
        configs: dict = None,
        parameters: dict = None,
        name='rpn_config',
        layer_configs: dict | list = None,
        depth: int = None,
        depth_alloc: int | list = None,
        device: str = 'cpu',
        *args, **kwargs
    ):
        """
        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.
        """

        if configs is not None:
            super().__init__(name=name, configs=configs, device=device, *args, **kwargs)
        elif parameters is not None:
            configs = {
                'model_class': 'tinybig.mode.rpn_model',
                'model_parameters': parameters,
            }
            super().__init__(name=name, configs=configs, device=device, *args, **kwargs)
        elif layer_configs is not None:
            parameters = {
                'name': name,
                'depth': depth,
                'depth_alloc': depth_alloc,
                'layer_configs': layer_configs,
                'device': device,
            }
            configs = {
                'model_class': 'tinybig.mode.rpn_model',
                'model_parameters': parameters,
            }
            super().__init__(name=name, configs=configs, device=device, *args, **kwargs)
        else:
            super().__init__(name=name, configs=None, device=device, *args, **kwargs)

    def to_instantiation(self):
        if self.configs is None:
            raise ValueError('The model configs object cannot be none...')
        self.process_depth_alloc_layer_configs()

        return config.instantiation_from_configs(
            configs=self.configs,
            device=self.device,
            class_name='model_class',
            parameter_name='model_parameters'
        )

    def process_depth_alloc_layer_configs(self):
        if self.configs is None or 'model_class' not in self.configs or 'model_parameters' not in self.configs:
            raise ValueError("the config dict cannot be none and should contain model configuration details...")

        depth = self.configs['model_parameters']['depth'] if 'depth' in self.configs['model_parameters'] else None
        depth_alloc = self.configs['model_parameters']['depth_alloc'] if 'depth_alloc' in self.configs['model_parameters'] else None
        layer_configs = self.configs['model_parameters']['layer_configs'] if 'layer_configs' in self.configs['model_parameters'] else None

        depth, depth_alloc, layer_configs = config.process_num_alloc_configs(
            num=depth,
            num_alloc=depth_alloc,
            configs=layer_configs,
        )

        self.configs['model_parameters']['depth'] = depth
        self.configs['model_parameters']['depth_alloc'] = depth_alloc
        self.configs['model_parameters']['layer_configs'] = layer_configs

__init__(configs=None, parameters=None, name='rpn_config', layer_configs=None, depth=None, depth_alloc=None, device='cpu', *args, **kwargs)

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/model_config.py 
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
def __init__(
    self,
    configs: dict = None,
    parameters: dict = None,
    name='rpn_config',
    layer_configs: dict | list = None,
    depth: int = None,
    depth_alloc: int | list = None,
    device: str = 'cpu',
    *args, **kwargs
):
    """
    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.
    """

    if configs is not None:
        super().__init__(name=name, configs=configs, device=device, *args, **kwargs)
    elif parameters is not None:
        configs = {
            'model_class': 'tinybig.mode.rpn_model',
            'model_parameters': parameters,
        }
        super().__init__(name=name, configs=configs, device=device, *args, **kwargs)
    elif layer_configs is not None:
        parameters = {
            'name': name,
            'depth': depth,
            'depth_alloc': depth_alloc,
            'layer_configs': layer_configs,
            'device': device,
        }
        configs = {
            'model_class': 'tinybig.mode.rpn_model',
            'model_parameters': parameters,
        }
        super().__init__(name=name, configs=configs, device=device, *args, **kwargs)
    else:
        super().__init__(name=name, configs=None, device=device, *args, **kwargs)