Skip to content

Commit b576201

Browse files
authored
Added doc strings to wandb logger (#9109)
1 parent b13749b commit b576201

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

pytorch_lightning/loggers/wandb.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,15 +219,33 @@ def log_metrics(self, metrics: Dict[str, float], step: Optional[int] = None) ->
219219

220220
@property
221221
def save_dir(self) -> Optional[str]:
222+
"""
223+
Gets the save directory.
224+
225+
Returns:
226+
The path to the save directory.
227+
"""
222228
return self._save_dir
223229

224230
@property
225231
def name(self) -> Optional[str]:
232+
"""
233+
Gets the name of the experiment.
234+
235+
Returns:
236+
The name of the experiment if the experiment exists else the name given to the constructor.
237+
"""
226238
# don't create an experiment if we don't have one
227239
return self._experiment.project_name() if self._experiment else self._name
228240

229241
@property
230242
def version(self) -> Optional[str]:
243+
"""
244+
Gets the id of the experiment.
245+
246+
Returns:
247+
The id of the experiment if the experiment exists else the id given to the constructor.
248+
"""
231249
# don't create an experiment if we don't have one
232250
return self._experiment.id if self._experiment else self._id
233251

0 commit comments

Comments
 (0)