Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstring to HyperparametersMixin #9253

Merged
merged 2 commits into from
Sep 2, 2021
Merged

Add docstring to HyperparametersMixin #9253

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1676087
Add docstring to HyperparametersMixin
popfido Sep 1, 2021
f253514
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions pytorch_lightning/core/mixins/hparams_mixin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,26 @@ def _to_hparams_dict(hp: Union[MutableMapping, Namespace, str]):

@property
def hparams(self) -> Union[AttributeDict, dict, Namespace]:
"""
The collection of hyperparameters saved with :meth:`save_hyperparameters`. It is mutable by the user.
For the frozen set of initial hyperparameters, use :attr:`hparams_initial`.

Returns:
Union[AttributeDict, dict, Namespace]: mutable hyperparameters dicionary
"""
if not hasattr(self, "_hparams"):
self._hparams = AttributeDict()
return self._hparams

@property
def hparams_initial(self) -> AttributeDict:
"""
The collection of hyperparameters saved with :meth:`save_hyperparameters`. These contents are read-only.
Manual updates to the saved hyperparameters can instead be performed through :attr:`hparams`.

Returns:
AttributeDict: immutable initial hyperparameters
"""
if not hasattr(self, "_hparams_initial"):
return AttributeDict()
# prevent any change
Expand Down