File tree Expand file tree Collapse file tree 1 file changed +18
-0
lines changed
pytorch_lightning/loggers Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Original file line number Diff line number Diff line change @@ -267,17 +267,35 @@ def finalize(self, status: str) -> None:
267267
268268 @property
269269 def save_dir (self ) -> Optional [str ]:
270+ """
271+ Gets the save directory of the experiment which in this case is ``None`` because Neptune does not save locally.
272+
273+ Returns:
274+ None
275+ """
270276 # Neptune does not save any local files
271277 return None
272278
273279 @property
274280 def name (self ) -> str :
281+ """
282+ Gets the name of the experiment.
283+
284+ Returns:
285+ The name of the experiment if not in offline mode else "offline-name".
286+ """
275287 if self .offline_mode :
276288 return "offline-name"
277289 return self .experiment .name
278290
279291 @property
280292 def version (self ) -> str :
293+ """
294+ Gets the id of the experiment.
295+
296+ Returns:
297+ The id of the experiment if not in offline mode else "offline-id-1234".
298+ """
281299 if self .offline_mode :
282300 return "offline-id-1234"
283301 return self .experiment .id
You can’t perform that action at this time.
0 commit comments