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.

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

Add docstrings to Test Tube logger #9110

Merged
merged 2 commits into from
Aug 25, 2021
Merged
Changes from all commits
Commits
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/test_tube.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,17 +197,35 @@ def close(self) -> 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) -> str:
"""
Gets the experiment name.

Returns:
The experiment name if the experiment exists, else the name specified in the constructor.
"""
if self._experiment is None:
return self._name

return self.experiment.name

@property
def version(self) -> int:
"""
Gets the experiment version.

Returns:
The experiment version if the experiment exists, else the next version.
"""
if self._experiment is None:
return self._version

Expand Down