parsing¶
Functions
Removes all unpicklable entries from hparams. |
|
Recursively collects the arguments passed to the child constructors in the inheritance tree. |
|
For backwards compatibility: #16369. |
|
Tests if an object can be pickled. |
|
Special getattr for Lightning. |
|
Special hasattr for Lightning. |
|
Special setattr for Lightning. |
|
Parse key words for standard |
|
See |
Classes
Extended dictionary accessible with dot notation. |
Utilities used for parameter parsing.
- class lightning.pytorch.utilities.parsing.AttributeDict[source]¶
Bases:
Dict
Extended dictionary accessible with dot notation.
>>> ad = AttributeDict({'key1': 1, 'key2': 'abc'}) >>> ad.key1 1 >>> ad.update({'my-key': 3.14}) >>> ad.update(new_key=42) >>> ad.key1 = 2 >>> ad "key1": 2 "key2": abc "my-key": 3.14 "new_key": 42
- lightning.pytorch.utilities.parsing.clean_namespace(hparams)[source]¶
Removes all unpicklable entries from hparams.
- Return type
- lightning.pytorch.utilities.parsing.collect_init_args(frame, path_args, inside=False, classes=())[source]¶
Recursively collects the arguments passed to the child constructors in the inheritance tree.
- Parameters
frame¶ (
frame
) – the current stack framepath_args¶ (
List
[Dict
[str
,Any
]]) – a list of dictionaries containing the constructor args in all parent classesinside¶ (
bool
) – track if we are inside inheritance path, avoid terminating too soonclasses¶ (
Tuple
[Type
,...
]) – the classes in which to inspect the frames
- Return type
- Returns
A list of dictionaries where each dictionary contains the arguments passed to the constructor at that level. The last entry corresponds to the constructor call of the most specific class in the hierarchy.
- lightning.pytorch.utilities.parsing.get_init_args(frame)[source]¶
For backwards compatibility: #16369.
- lightning.pytorch.utilities.parsing.is_picklable(obj)[source]¶
Tests if an object can be pickled.
- Return type
- lightning.pytorch.utilities.parsing.lightning_getattr(model, attribute)[source]¶
Special getattr for Lightning. Checks for attribute in model namespace, the old hparams namespace/dict, and the datamodule.
- Raises
AttributeError – If
model
doesn’t haveattribute
in any of model namespace, the hparams namespace/dict, and the datamodule.- Return type
- lightning.pytorch.utilities.parsing.lightning_hasattr(model, attribute)[source]¶
Special hasattr for Lightning.
Checks for attribute in model namespace, the old hparams namespace/dict, and the datamodule.
- Return type
- lightning.pytorch.utilities.parsing.lightning_setattr(model, attribute, value)[source]¶
Special setattr for Lightning. Checks for attribute in model namespace and the old hparams namespace/dict. Will also set the attribute on datamodule, if it exists.
- Raises
AttributeError – If
model
doesn’t haveattribute
in any of model namespace, the hparams namespace/dict, and the datamodule.- Return type