Skip to content

Commit ccc83e7

Browse files
bamblebamtchaton
andauthored
Add doc strings to CSV logger (#9112)
Co-authored-by: tchaton <[email protected]>
1 parent eacece1 commit ccc83e7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

pytorch_lightning/loggers/csv_logs.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,12 @@ def log_dir(self) -> str:
161161

162162
@property
163163
def save_dir(self) -> Optional[str]:
164+
"""
165+
The current directory where logs are saved.
166+
167+
Returns:
168+
The path to current directory where logs are saved.
169+
"""
164170
return self._save_dir
165171

166172
@property
@@ -204,10 +210,22 @@ def finalize(self, status: str) -> None:
204210

205211
@property
206212
def name(self) -> str:
213+
"""
214+
Gets the name of the experiment.
215+
216+
Returns:
217+
The name of the experiment.
218+
"""
207219
return self._name
208220

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

0 commit comments

Comments
 (0)