Skip to content

Fix URLs in NeptuneLogger docstring #21372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+7 −7
Open

Fix URLs in NeptuneLogger docstring #21372

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/lightning/pytorch/loggers/neptune.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@


class NeptuneLogger(Logger):
r"""Log using `Neptune <https://docs.neptune.ai/integrations/lightning/>`_.
r"""Log using `Neptune <https://docs-legacy.neptune.ai/integrations/lightning/>`_.

Install it with pip:

Expand Down Expand Up @@ -97,7 +97,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 <https://docs.neptune.ai/logging/methods>`_
Refer to the `Neptune docs <https://docs-legacy.neptune.ai/logging/methods>`_
for details.
You can also use the regular logger methods ``log_metrics()``, and ``log_hyperparams()`` with NeptuneLogger.

Expand Down Expand Up @@ -152,7 +152,7 @@ def any_lightning_module_function_or_hook(self):
)
trainer = Trainer(max_epochs=3, logger=neptune_logger)

Check `run documentation <https://docs.neptune.ai/api/neptune/#init_run>`_
Check `run documentation <https://docs-legacy.neptune.ai/api/neptune/#init_run>`_
for more info about additional run parameters.

**Details about Neptune run structure**
Expand All @@ -164,18 +164,18 @@ def any_lightning_module_function_or_hook(self):

See also:
- Read about
`what objects you can log to Neptune <https://docs.neptune.ai/logging/what_you_can_log/>`_.
`what objects you can log to Neptune <https://docs-legacy.neptune.ai/logging/what_you_can_log/>`_.
- Check out an `example run <https://app.neptune.ai/o/common/org/pytorch-lightning-integration/e/PTL-1/all>`_
with multiple types of metadata logged.
- For more detailed examples, see the
`user guide <https://docs.neptune.ai/integrations/lightning/>`_.
`user guide <https://docs-legacy.neptune.ai/integrations/lightning/>`_.

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 <https://docs.neptune.ai/setup/setting_api_token/>`_.
Instructions: `Setting your API token <https://docs-legacy.neptune.ai/setup/setting_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.
Expand Down Expand Up @@ -251,7 +251,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 <https://docs.neptune.ai/logging/methods>`_
`Neptune docs <https://docs-legacy.neptune.ai/logging/methods>`_
for more detailed explanations.
You can also use the regular logger methods ``log_metrics()``, and ``log_hyperparams()``
with NeptuneLogger.
Expand Down