tfm.optimization.LAMBConfig
Stay organized with collections
Save and categorize content based on your preferences.
Configuration for LAMB optimizer.
Inherits From: BaseOptimizerConfig, Config, ParamsDict
View aliases
Main aliases
tfm.optimization.LAMBConfig(
default_params: dataclasses.InitVar[Optional[Mapping[str, Any]]] = None,
restrictions: dataclasses.InitVar[Optional[List[str]]] = None,
clipnorm: Optional[float] = None,
clipvalue: Optional[float] = None,
global_clipnorm: Optional[float] = None,
name: str = 'LAMB',
beta_1: float = 0.9,
beta_2: float = 0.999,
epsilon: float = 1e-06,
weight_decay_rate: float = 0.0,
exclude_from_weight_decay: Optional[List[str]] = None,
exclude_from_layer_adaptation: Optional[List[str]] = None
)
The attributes for this class matches the arguments of LAMB optimizer.
Attributes | |
|---|---|
name
|
name of the optimizer. |
beta_1
|
decay rate for 1st order moments. |
beta_2
|
decay rate for 2st order moments. |
epsilon
|
epsilon value used for numerical stability in LAMB optimizer. |
weight_decay_rate
|
float. Weight decay rate. Default to 0. |
exclude_from_weight_decay
|
List of regex patterns of variables excluded from weight decay. Variables whose name contain a substring matching the pattern will be excluded. |
exclude_from_layer_adaptation
|
List of regex patterns of variables excluded from layer adaptation. Variables whose name contain a substring matching the pattern will be excluded. |
BUILDER
|
|
default_params
|
Dataclass field |
restrictions
|
Dataclass field |
clipnorm
|
Dataclass field |
clipvalue
|
Dataclass field |
global_clipnorm
|
Dataclass field |
Methods
as_dict
as_dict()
Returns a dict representation of params_dict.ParamsDict.
For the nested params_dict.ParamsDict, a nested dict will be returned.
from_args
@classmethodfrom_args( *args, **kwargs )
Builds a config from the given list of arguments.
from_json
@classmethodfrom_json( file_path: str )
Wrapper for from_yaml.
from_yaml
@classmethodfrom_yaml( file_path: str )
get
get(
key, value=None
)
Accesses through built-in dictionary get method.
lock
lock()
Makes the ParamsDict immutable.
override
override(
override_params, is_strict=True
)
Override the ParamsDict with a set of given params.
| Args | |
|---|---|
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.
|
replace
replace(
**kwargs
)
Overrides/returns a unlocked copy with the current config unchanged.
validate
validate()
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
a:
a1: 1
a2: 2
b:
bb:
bb1: 10
bb2: 20
ccc:
a1: 1
a3: 3
one can define two restrictions like this ['a.a1 == b.ccc.a1', 'a.a2 <= b.bb.bb2']
| What it enforces are | |
|---|---|
|
| Raises | |
|---|---|
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. |
__contains__
__contains__(
key
)
Implements the membership test operator.
__eq__
__eq__(
other
)
Class Variables | |
|---|---|
| IMMUTABLE_TYPES |
(<class 'str'>,
<class 'int'>,
<class 'float'>,
<class 'bool'>,
<class 'NoneType'>)
|
| RESERVED_ATTR |
['_locked', '_restrictions']
|
| SEQUENCE_TYPES |
(<class 'list'>, <class 'tuple'>)
|
| beta_1 |
0.9
|
| beta_2 |
0.999
|
| clipnorm |
None
|
| clipvalue |
None
|
| default_params |
None
|
| epsilon |
1e-06
|
| exclude_from_layer_adaptation |
None
|
| exclude_from_weight_decay |
None
|
| global_clipnorm |
None
|
| name |
'LAMB'
|
| restrictions |
None
|
| weight_decay_rate |
0.0
|