Add doc strings for Neptune logger (#9111)

Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
This commit is contained in:
Burhanuddin Rangwala 2021-08-27 14:15:52 +05:30 committed by GitHub
parent 6da3a6185f
commit e133061cd3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions

View File

@ -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