From e133061cd350afe7484aa184778be1ec26241d50 Mon Sep 17 00:00:00 2001 From: Burhanuddin Rangwala Date: Fri, 27 Aug 2021 14:15:52 +0530 Subject: [PATCH] Add doc strings for Neptune logger (#9111) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrian Wälchli --- pytorch_lightning/loggers/neptune.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/pytorch_lightning/loggers/neptune.py b/pytorch_lightning/loggers/neptune.py index f179745d6d..b810aebce4 100644 --- a/pytorch_lightning/loggers/neptune.py +++ b/pytorch_lightning/loggers/neptune.py @@ -267,17 +267,35 @@ class NeptuneLogger(LightningLoggerBase): @property def save_dir(self) -> Optional[str]: + """ + Gets the save directory of the experiment which in this case is ``None`` because Neptune does not save locally. + + Returns: + None + """ # Neptune does not save any local files return None @property def name(self) -> str: + """ + Gets the name of the experiment. + + Returns: + The name of the experiment if not in offline mode else "offline-name". + """ if self.offline_mode: return "offline-name" return self.experiment.name @property def version(self) -> str: + """ + Gets the id of the experiment. + + Returns: + The id of the experiment if not in offline mode else "offline-id-1234". + """ if self.offline_mode: return "offline-id-1234" return self.experiment.id