Skip to content

Commit a30d6a0

Browse files
bamblebamethanwharris
authored andcommitted
Add docstrings to Test Tube logger (#9110)
1 parent 817d344 commit a30d6a0

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

pytorch_lightning/loggers/test_tube.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,17 +197,35 @@ def close(self) -> None:
197197

198198
@property
199199
def save_dir(self) -> Optional[str]:
200+
"""
201+
Gets the save directory.
202+
203+
Returns:
204+
The path to the save directory.
205+
"""
200206
return self._save_dir
201207

202208
@property
203209
def name(self) -> str:
210+
"""
211+
Gets the experiment name.
212+
213+
Returns:
214+
The experiment name if the experiment exists, else the name specified in the constructor.
215+
"""
204216
if self._experiment is None:
205217
return self._name
206218

207219
return self.experiment.name
208220

209221
@property
210222
def version(self) -> int:
223+
"""
224+
Gets the experiment version.
225+
226+
Returns:
227+
The experiment version if the experiment exists, else the next version.
228+
"""
211229
if self._experiment is None:
212230
return self._version
213231

0 commit comments

Comments
 (0)