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

Added doc strings to wandb logger #9109

Merged
merged 3 commits into from
Aug 26, 2021
Merged

Added doc strings to wandb logger #9109

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebafb31
added doc strings to wandb logger
bamblebam Aug 25, 2021
ce6993a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 25, 2021
d7c8352
updated doc strings
bamblebam Aug 26, 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
18 changes: 18 additions & 0 deletions pytorch_lightning/loggers/wandb.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,15 +219,33 @@ def log_metrics(self, metrics: Dict[str, float], step: Optional[int] = None) ->

@property
def save_dir(self) -> Optional[str]:
"""
Gets the save directory.

Returns:
The path to the save directory.
"""
return self._save_dir

@property
def name(self) -> Optional[str]:
"""
Gets the name of the experiment.

Returns:
The name of the experiment if the experiment exists else the name given to the constructor.
"""
# don't create an experiment if we don't have one
return self._experiment.project_name() if self._experiment else self._name

@property
def version(self) -> Optional[str]:
"""
Gets the id of the experiment.

Returns:
The id of the experiment if the experiment exists else the id given to the constructor.
"""
# don't create an experiment if we don't have one
return self._experiment.id if self._experiment else self._id

Expand Down