update for neptune 1.0 (#16761)

Co-authored-by: Sabine <[email protected]>
Co-authored-by: Jirka Borovec <[email protected]>
Co-authored-by: Carlos Mocholí <[email protected]>

(cherry picked from commit 04a2f33)

Author: kshitij12345

docs/source-pytorch/visualize/supported_exp_managers.rst

@@ -68,23 +68,24 @@ To use `Neptune.ai <https://neptune.ai/>`_ first install the neptune package:
 
 .. code-block:: bash
 
-    pip install neptune-client
+    pip install neptune
 
 or with conda:
 
 .. code-block:: bash
 
-    conda install -c conda-forge neptune-client
+    conda install -c conda-forge neptune
 
 Configure the logger and pass it to the :class:`~pytorch_lightning.trainer.trainer.Trainer`:
 
 .. testcode::
     :skipif: not _NEPTUNE_AVAILABLE
 
+    import neptune
     from pytorch_lightning.loggers import NeptuneLogger
 
     neptune_logger = NeptuneLogger(
-        api_key="ANONYMOUS",  # replace with your own
+        api_key=neptune.ANONYMOUS_API_TOKEN,  # replace with your own
         project="common/pytorch-lightning-integration",  # format "<WORKSPACE/PROJECT>"
     )
     trainer = Trainer(logger=neptune_logger)
@@ -96,7 +97,7 @@ Access the neptune logger from any function (except the LightningModule *init*)
     class LitModel(LightningModule):
         def any_lightning_module_function_or_hook(self):
             neptune_logger = self.logger.experiment["your/metadata/structure"]
-            neptune_logger.log(metadata)
+            neptune_logger.append(metadata)
 
 Here's the full documentation for the :class:`~pytorch_lightning.loggers.NeptuneLogger`.
 

requirements/pytorch/loggers.info

@@ -1,5 +1,5 @@
 # all supported loggers. this list is here as a reference, but they are not installed in CI
-neptune-client
+neptune
 comet-ml
 mlflow>=1.0.0
 wandb

src/pytorch_lightning/CHANGELOG.md

@@ -8,6 +8,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
 ### Changed
 
+- Changes to the `NeptuneLogger` ([#16761](https://github.com/Lightning-AI/lightning/pull/16761)):
+  * It now supports neptune-client 0.16.16 and neptune >=1.0, and we have replaced the `log()` method with `append()` and `extend()`.
+  * It now accepts a namespace `Handler` as an alternative to `Run` for the `run` argument. This means that you can call it like `NeptuneLogger(run=run["some/namespace"])` to log everything to the `some/namespace/` location of the run.
+
+### Depercated
+
 -
 
 

src/pytorch_lightning/loggers/neptune.py

@@ -45,6 +45,8 @@
     mock.patch("pytorch_lightning.loggers.mlflow.Metric"),
     mock.patch("pytorch_lightning.loggers.neptune.neptune", new_callable=create_neptune_mock),
     mock.patch("pytorch_lightning.loggers.neptune._NEPTUNE_AVAILABLE", return_value=True),
+    mock.patch("pytorch_lightning.loggers.neptune.Run", new=mock.Mock),
+    mock.patch("pytorch_lightning.loggers.neptune.Handler", new=mock.Mock),
     mock.patch("pytorch_lightning.loggers.wandb.wandb"),
     mock.patch("pytorch_lightning.loggers.wandb.Run", new=mock.Mock),
 )
@@ -294,13 +296,13 @@ def test_logger_with_prefix_all(tmpdir, monkeypatch):
     # Neptune
     with mock.patch("pytorch_lightning.loggers.neptune.neptune"), mock.patch(
         "pytorch_lightning.loggers.neptune._NEPTUNE_AVAILABLE", return_value=True
-    ):
+    ), mock.patch("pytorch_lightning.loggers.neptune.Handler", new=mock.Mock):
         logger = _instantiate_logger(NeptuneLogger, api_key="test", project="project", save_dir=tmpdir, prefix=prefix)
-        assert logger.experiment.__getitem__.call_count == 2
+        assert logger.experiment.__getitem__.call_count == 0
         logger.log_metrics({"test": 1.0}, step=0)
-        assert logger.experiment.__getitem__.call_count == 3
+        assert logger.experiment.__getitem__.call_count == 1
         logger.experiment.__getitem__.assert_called_with("tmp/test")
-        logger.experiment.__getitem__().log.assert_called_once_with(1.0)
+        logger.experiment.__getitem__().append.assert_called_once_with(1.0)
 
     # TensorBoard
     if _TENSORBOARD_AVAILABLE:

tests/tests_pytorch/loggers/test_all.py

@@ -51,6 +51,7 @@ def create_neptune_mock():
     return MagicMock(init_run=MagicMock(side_effect=create_run_mock))
 
 
+# Note: For testing purpose this mock `Run` will also be used to mock `Handler`.
 class Run:
     _project_name = "test-project"
 
@@ -77,6 +78,9 @@ def __getstate__(self):
     def exists(self, value):
         return True
 
+    def get_root_object(self):
+        return self
+
 
 @pytest.fixture
 def tmpdir_unittest_fixture(request, tmpdir):
@@ -94,6 +98,8 @@ def run(self, *args, **kwargs):
         with mock.patch("pytorch_lightning.loggers.neptune._NEPTUNE_AVAILABLE", return_value=True):
             super().run(*args, **kwargs)
 
+    @patch("pytorch_lightning.loggers.neptune.Run", Run)
+    @patch("pytorch_lightning.loggers.neptune.Handler", Run)
     def test_neptune_online(self, neptune):
         logger = NeptuneLogger(api_key="test", project="project")
         created_run_mock = logger.run
@@ -108,6 +114,8 @@ def test_neptune_online(self, neptune):
         created_run_mock.__getitem__.assert_has_calls([call("sys/id"), call("sys/name")], any_order=True)
         created_run_mock.__setitem__.assert_called_once_with("source_code/integrations/pytorch-lightning", __version__)
 
+    @patch("pytorch_lightning.loggers.neptune.Run", Run)
+    @patch("pytorch_lightning.loggers.neptune.Handler", Run)
     def test_neptune_offline(self, neptune):
         logger = NeptuneLogger(mode="offline")
         created_run_mock = logger.run
@@ -118,6 +126,7 @@ def test_neptune_offline(self, neptune):
         self.assertEqual(logger._run_name, "offline-name")
 
     @patch("pytorch_lightning.loggers.neptune.Run", Run)
+    @patch("pytorch_lightning.loggers.neptune.Handler", Run)
     def test_online_with_custom_run(self, neptune):
         created_run = Run()
         logger = NeptuneLogger(run=created_run)
@@ -128,6 +137,7 @@ def test_online_with_custom_run(self, neptune):
         self.assertEqual(neptune.init_run.call_count, 0)
 
     @patch("pytorch_lightning.loggers.neptune.Run", Run)
+    @patch("pytorch_lightning.loggers.neptune.Handler", Run)
     def test_neptune_pickling(self, neptune):
         unpickleable_run = Run()
         logger = NeptuneLogger(run=unpickleable_run)
@@ -140,6 +150,7 @@ def test_neptune_pickling(self, neptune):
         self.assertIsNotNone(unpickled.experiment)
 
     @patch("pytorch_lightning.loggers.neptune.Run", Run)
+    @patch("pytorch_lightning.loggers.neptune.Handler", Run)
     def test_online_with_wrong_kwargs(self, neptune):
         """Tests combinations of kwargs together with `run` kwarg which makes some of other parameters unavailable
         in init."""
@@ -222,8 +233,9 @@ def validation_epoch_end(self, outputs):
 
         # then
         run_instance_mock.__getitem__.assert_any_call("training/some/key")
-        run_instance_mock.__getitem__.return_value.log.assert_has_calls([call(42)])
+        run_instance_mock.__getitem__.return_value.append.assert_has_calls([call(42)])
 
+    @patch("pytorch_lightning.loggers.neptune.stringify_unsupported", lambda x: x)
     def test_log_hyperparams(self, neptune):
         params = {"foo": "bar", "nested_foo": {"bar": 42}}
         test_variants = [
@@ -268,7 +280,7 @@ def test_log_metrics(self, neptune):
             self.assertEqual(run_instance_mock.__getitem__.call_count, 2)
             run_instance_mock.__getitem__.assert_any_call(metrics_foo_key)
             run_instance_mock.__getitem__.assert_any_call(metrics_bar_key)
-            run_attr_mock.log.assert_has_calls([call(42), call(555)])
+            run_attr_mock.append.assert_has_calls([call(42), call(555)])
 
     def test_log_model_summary(self, neptune):
         model = BoringModel()

tests/tests_pytorch/loggers/test_neptune.py

@@ -1393,15 +1393,15 @@ def test_comet_logger_init_args():
     )
 
 
-@pytest.mark.skipif(not _NEPTUNE_AVAILABLE, reason="neptune-client is required")
+@pytest.mark.skipif(not _NEPTUNE_AVAILABLE, reason="neptune is required")
 def test_neptune_logger_init_args():
     _test_logger_init_args(
         "NeptuneLogger",
         {
             "name": "neptune",  # Resolve from NeptuneLogger.__init__
         },
         {
-            "description": "neptune",  # Unsupported resolving from neptune.new.internal.init.run.init_run
+            "description": "neptune",  # Unsupported resolving from neptune.internal.init.run.init_run
         },
     )
 

tests/tests_pytorch/test_cli.py

@@ -117,7 +117,7 @@ def clean_import():
         ("torch.distributed.is_available", _shortcut_patch(is_available, ()), "pytorch_lightning"),
         (
             "lightning_utilities.core.imports.RequirementCache.__bool__",
-            _shortcut_patch(RequirementCache.__bool__, ("neptune-client",), ("requirement",)),
+            _shortcut_patch(RequirementCache.__bool__, ("neptune",), ("requirement",)),
             "pytorch_lightning.loggers.neptune",
         ),
         (