Inherits From: Config, ParamsDict


default_params Dataclass field
restrictions Dataclass field
num_channels Dataclass field
match_threshold Dataclass field
unmatched_threshold Dataclass field
aug_rand_hflip Dataclass field
aug_rand_vflip Dataclass field
aug_scale_min Dataclass field
aug_scale_max Dataclass field
aug_type Dataclass field
skip_crowd_during_training Dataclass field
max_num_instances Dataclass field
rpn_match_threshold Dataclass field
rpn_unmatched_threshold Dataclass field
rpn_batch_size_per_im Dataclass field
rpn_fg_fraction Dataclass field
mask_crop_size Dataclass field
pad Dataclass field



View source

Returns a dict representation of params_dict.ParamsDict.

For the nested params_dict.ParamsDict, a nested dict will be returned.


View source

Builds a config from the given list of arguments.


View source

Wrapper for from_yaml.


View source


View source

Accesses through built-in dictionary get method.


View source

Makes the ParamsDict immutable.


View source

Override the ParamsDict with a set of given params.

override_params a dict or a ParamsDict specifying the parameters to be overridden.
is_strict a boolean specifying whether override is strict or not. If True, keys in override_params must be present in the ParamsDict. If False, keys in override_params can be different from what is currently defined in the ParamsDict. In this case, the ParamsDict will be extended to include the new keys.


View source

Overrides/returns a unlocked copy with the current config unchanged.


View source

Validate the parameters consistency based on the restrictions.

This method validates the internal consistency using the pre-defined list of restrictions. A restriction is defined as a string which specifies a binary operation. The supported binary operations are {'==', '!=', '<', '<=', '>', '>='}. Note that the meaning of these operators are consistent with the underlying Python immplementation. Users should make sure the define restrictions on their type make sense.

For example, for a ParamsDict like the following

  a1: 1
  a2: 2
    bb1: 10
    bb2: 20
    a1: 1
    a3: 3

one can define two restrictions like this ['a.a1 == b.ccc.a1', 'a.a2 <=']

What it enforces are

  • a.a1 = 1 == b.ccc.a1 = 1
  • a.a2 = 2 <= = 20

KeyError if any of the following happens (1) any of parameters in any of restrictions is not defined in ParamsDict, (2) any inconsistency violating the restriction is found.
ValueError if the restriction defined in the string is not supported.


View source

Implements the membership test operator.


IMMUTABLE_TYPES (<class 'str'>, <class 'int'>, <class 'float'>, <class 'bool'>, <class 'NoneType'>)
RESERVED_ATTR ['_locked', '_restrictions']
SEQUENCE_TYPES (<class 'list'>, <class 'tuple'>)
aug_rand_hflip False
aug_rand_vflip False
aug_scale_max 1.0
aug_scale_min 1.0
aug_type None
default_params None
mask_crop_size 112
match_threshold 0.5
max_num_instances 100
num_channels 3
pad True
restrictions None
rpn_batch_size_per_im 256
rpn_fg_fraction 0.5
rpn_match_threshold 0.7
rpn_unmatched_threshold 0.3
skip_crowd_during_training True
unmatched_threshold 0.5