flax.core.frozen_dict package#
- class flax.core.frozen_dict.FrozenDict(*args, __unsafe_skip_copy__=False, **kwargs)[source]#
An immutable variant of the Python dict.
- copy(add_or_replace=mappingproxy({}))[source]#
Create a new FrozenDict with additional or replaced entries.
- flax.core.frozen_dict.freeze(xs)[source]#
Freeze a nested dict.
Makes a nested dict immutable by transforming it into FrozenDict.
- flax.core.frozen_dict.unfreeze(x)[source]#
Unfreeze a FrozenDict.
Makes a mutable copy of a FrozenDict mutable by transforming it into (nested) dict.
- flax.core.frozen_dict.copy(x, add_or_replace=FrozenDict({}))[source]#
Create a new dict with additional and/or replaced entries. This is a utility function that can act on either a FrozenDict or regular dict and mimics the behavior of FrozenDict.copy.
Example:
new_variables = copy(variables, {‘additional_entries’: 1})
- Parameters:
- Return type:
Union
[FrozenDict
,Dict
[str
,Any
]]- Returns:
A new dict with the additional and/or replaced entries.
- flax.core.frozen_dict.pop(x, key)[source]#
Create a new dict where one entry is removed. This is a utility function that can act on either a FrozenDict or regular dict and mimics the behavior of FrozenDict.pop.
Example:
state, params = pop(variables, 'params')
- flax.core.frozen_dict.pretty_repr(x, num_spaces=4)[source]#
Returns an indented representation of the nested dictionary. This is a utility function that can act on either a FrozenDict or regular dict and mimics the behavior of FrozenDict.pretty_repr. If x is any other dtype, this function will return repr(x).