diff --git a/src/lightning/pytorch/loggers/neptune.py b/src/lightning/pytorch/loggers/neptune.py index bf9669c824784..c3d73edc5c8dd 100644 --- a/src/lightning/pytorch/loggers/neptune.py +++ b/src/lightning/pytorch/loggers/neptune.py @@ -64,7 +64,7 @@ def wrapper(*args: Any, **kwargs: Any) -> Any: class NeptuneLogger(Logger): - r"""Log using `Neptune `_. + r"""Log using `Neptune `_. Install it with pip: @@ -124,7 +124,7 @@ def any_lightning_module_function_or_hook(self): Note that the syntax ``self.logger.experiment["your/metadata/structure"].append(metadata)`` is specific to Neptune and extends the logger capabilities. It lets you log various types of metadata, such as scores, files, images, interactive visuals, and CSVs. - Refer to the `Neptune docs `_ + Refer to the `Neptune docs `_ for details. You can also use the regular logger methods ``log_metrics()``, and ``log_hyperparams()`` with NeptuneLogger. @@ -179,7 +179,7 @@ def any_lightning_module_function_or_hook(self): ) trainer = Trainer(max_epochs=3, logger=neptune_logger) - Check `run documentation `_ + Check `run documentation `_ for more info about additional run parameters. **Details about Neptune run structure** @@ -191,18 +191,18 @@ def any_lightning_module_function_or_hook(self): See also: - Read about - `what objects you can log to Neptune `_. + `what objects you can log to Neptune `_. - Check out an `example run `_ with multiple types of metadata logged. - For more detailed examples, see the - `user guide `_. + `user guide `_. Args: api_key: Optional. Neptune API token, found on https://www.neptune.ai upon registration. You should save your token to the `NEPTUNE_API_TOKEN` environment variable and leave the api_key argument out of your code. - Instructions: `Setting your API token `_. + Instructions: `Setting your API token `_. project: Optional. Name of a project in the form "workspace-name/project-name", for example "tom/mask-rcnn". If ``None``, the value of `NEPTUNE_PROJECT` environment variable is used. @@ -372,7 +372,7 @@ def training_step(self, batch, batch_idx): is specific to Neptune and extends the logger capabilities. It lets you log various types of metadata, such as scores, files, images, interactive visuals, and CSVs. Refer to the - `Neptune docs `_ + `Neptune docs `_ for more detailed explanations. You can also use the regular logger methods ``log_metrics()``, and ``log_hyperparams()`` with NeptuneLogger.