Skip to content

Commit 5719f45

Browse files
committed
Fix urls in NeptuneLogger docstring
Neptune updated their API and docs to version 3.X. This commit fixes the urls in the NeptuneLogger docstring to point to the correct version 2.X legacy docs.
1 parent 8f702b3 commit 5719f45

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

src/lightning/pytorch/loggers/neptune.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737

3838

3939
class NeptuneLogger(Logger):
40-
r"""Log using `Neptune <https://docs.neptune.ai/integrations/lightning/>`_.
40+
r"""Log using `Neptune <https://docs-legacy.neptune.ai/integrations/lightning/>`_.
4141
4242
Install it with pip:
4343
@@ -97,7 +97,7 @@ def any_lightning_module_function_or_hook(self):
9797
Note that the syntax ``self.logger.experiment["your/metadata/structure"].append(metadata)`` is specific to
9898
Neptune and extends the logger capabilities. It lets you log various types of metadata, such as
9999
scores, files, images, interactive visuals, and CSVs.
100-
Refer to the `Neptune docs <https://docs.neptune.ai/logging/methods>`_
100+
Refer to the `Neptune docs <https://docs-legacy.neptune.ai/logging/methods>`_
101101
for details.
102102
You can also use the regular logger methods ``log_metrics()``, and ``log_hyperparams()`` with NeptuneLogger.
103103
@@ -152,7 +152,7 @@ def any_lightning_module_function_or_hook(self):
152152
)
153153
trainer = Trainer(max_epochs=3, logger=neptune_logger)
154154
155-
Check `run documentation <https://docs.neptune.ai/api/neptune/#init_run>`_
155+
Check `run documentation <https://docs-legacy.neptune.ai/api/neptune/#init_run>`_
156156
for more info about additional run parameters.
157157
158158
**Details about Neptune run structure**
@@ -164,18 +164,18 @@ def any_lightning_module_function_or_hook(self):
164164
165165
See also:
166166
- Read about
167-
`what objects you can log to Neptune <https://docs.neptune.ai/logging/what_you_can_log/>`_.
167+
`what objects you can log to Neptune <https://docs-legacy.neptune.ai/logging/what_you_can_log/>`_.
168168
- Check out an `example run <https://app.neptune.ai/o/common/org/pytorch-lightning-integration/e/PTL-1/all>`_
169169
with multiple types of metadata logged.
170170
- For more detailed examples, see the
171-
`user guide <https://docs.neptune.ai/integrations/lightning/>`_.
171+
`user guide <https://docs-legacy.neptune.ai/integrations/lightning/>`_.
172172
173173
Args:
174174
api_key: Optional.
175175
Neptune API token, found on https://www.neptune.ai upon registration.
176176
You should save your token to the `NEPTUNE_API_TOKEN`
177177
environment variable and leave the api_key argument out of your code.
178-
Instructions: `Setting your API token <https://docs.neptune.ai/setup/setting_api_token/>`_.
178+
Instructions: `Setting your API token <https://docs-legacy.neptune.ai/setup/setting_api_token/>`_.
179179
project: Optional.
180180
Name of a project in the form "workspace-name/project-name", for example "tom/mask-rcnn".
181181
If ``None``, the value of `NEPTUNE_PROJECT` environment variable is used.
@@ -251,7 +251,7 @@ def training_step(self, batch, batch_idx):
251251
is specific to Neptune and extends the logger capabilities.
252252
It lets you log various types of metadata, such as scores, files,
253253
images, interactive visuals, and CSVs. Refer to the
254-
`Neptune docs <https://docs.neptune.ai/logging/methods>`_
254+
`Neptune docs <https://docs-legacy.neptune.ai/logging/methods>`_
255255
for more detailed explanations.
256256
You can also use the regular logger methods ``log_metrics()``, and ``log_hyperparams()``
257257
with NeptuneLogger.

0 commit comments

Comments
 (0)