docs: migration guide to the latest [2/n] (#17103)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: Borda

docs/source-pytorch/advanced/training_tricks.rst

@@ -70,6 +70,8 @@ read `this post <https://pytorch.org/blog/pytorch-1.6-now-includes-stochastic-we
 
 ----------
 
+.. _batch_size_finder:
+
 *****************
 Batch Size Finder
 *****************

docs/source-pytorch/upgrade/from_1_4.rst

@@ -1,7 +1,5 @@
 :orphan:
 
-.. include:: link_refs.rst
-
 Upgrade from 1.4 to the 2.0
 ###########################
 

docs/source-pytorch/upgrade/from_1_5.rst

@@ -1,7 +1,5 @@
 :orphan:
 
-.. include:: link_refs.rst
-
 Upgrade from 1.5 to the 2.0
 ###########################
 

docs/source-pytorch/upgrade/from_1_6.rst

@@ -1,7 +1,5 @@
 :orphan:
 
-.. include:: link_refs.rst
-
 Upgrade from 1.6 to the 2.0
 ###########################
 

docs/source-pytorch/upgrade/from_1_7.rst

@@ -1,7 +1,5 @@
 :orphan:
 
-.. include:: link_refs.rst
-
 Upgrade from 1.7 to the 2.0
 ###########################
 

docs/source-pytorch/upgrade/from_1_8.rst

@@ -1,7 +1,5 @@
 :orphan:
 
-.. include:: link_refs.rst
-
 Upgrade from 1.8 to the 2.0
 ###########################
 

docs/source-pytorch/upgrade/from_1_9.rst

@@ -1,7 +1,5 @@
 :orphan:
 
-.. include:: link_refs.rst
-
 Regular User
 ************
 

docs/source-pytorch/upgrade/link_refs.rst

@@ -8,28 +8,36 @@
 
    * - called ``ModelCheckpoint.save_function``
      - now call ``Trainer.save_checkpoint``
-     - #7201
+     - `PR7201`_
 
    * - accessed the ``Trainer.running_sanity_check`` property
      - now  access the ``Trainer.sanity_checking`` property
-     - #4945
+     - `PR4945`_
 
    * - used ``LightningModule.grad_norm``
      - now use the ``pl.utilities.grad_norm`` utility function instead
-     - #7292
+     - `PR7292`_
 
    * - used ``TrainerTrainingTricksMixin.detect_nan_tensors``
      - now use ``pl.utilities.grads.grad_norm``
-     - #6834
+     - `PR6834`_
 
    * - used ``TrainerTrainingTricksMixin.print_nan_gradients``
      - now use ``pl.utilities.finite_checks.print_nan_gradients``
-     - #6834
+     - `PR6834`_
 
    * - If you relied on ``TrainerLoggingMixin.metrics_to_scalars``
      - now use ``pl.utilities.metrics.metrics_to_scalars``
-     - #7180
+     - `PR7180`_
 
    * - selected the i-th GPU with ``Trainer(gpus="i,j")``
      - now this will set the number of GPUs, just like passing ``Trainer(devices=i)``, you can still select the specific GPU by setting the ``CUDA_VISIBLE_DEVICES=i,j`` environment variable
-     - #6388
+     - `PR6388`_
+
+
+.. _pr7201: https://github.com/Lightning-AI/lightning/pull/7201
+.. _pr4945: https://github.com/Lightning-AI/lightning/pull/4945
+.. _pr7292: https://github.com/Lightning-AI/lightning/pull/7292
+.. _pr6834: https://github.com/Lightning-AI/lightning/pull/6834
+.. _pr7180: https://github.com/Lightning-AI/lightning/pull/7180
+.. _pr6388: https://github.com/Lightning-AI/lightning/pull/6388

docs/source-pytorch/upgrade/sections/1_4_advanced.rst

@@ -8,40 +8,52 @@
 
    * - relied on the ``outputs`` in your  ``LightningModule.on_train_epoch_end`` or ``Callback.on_train_epoch_end`` hooks
      - rely on either ``on_train_epoch_end`` or set outputs as attributes in your ``LightningModule`` instances and access them from the hook
-     - #7339
+     - `PR7339`_
 
    * - accessed ``Trainer.truncated_bptt_steps``
      - swicth to manual optimization
-     - #7323
+     - `PR7323`_
 
    * - called  ``LightningModule.write_predictions``  and  ``LightningModule.write_predictions_dict``
      - rely on ``predict_step`` and ``Trainer.predict`` + callbacks to write out predictions
-     - #7066
+     - `PR7066`_
 
    * - passed the ``period`` argument to the ``ModelCheckpoint`` callback
      - pass the ``every_n_epochs`` argument to the ``ModelCheckpoint`` callback
-     - #6146
+     - `PR6146`_
 
    * - passed the ``output_filename`` argument to ``Profiler``
      - now pass ``dirpath`` and ``filename``, that is  ``Profiler(dirpath=...., filename=...)``
-     - #6621
+     - `PR6621`_
 
    * - passed the ``profiled_functions`` argument in  ``PytorchProfiler``
      - now pass the  ``record_functions`` argument
-     - #6349
+     - `PR6349`_
 
    * - relied on the ``@auto_move_data`` decorator to use the ``LightningModule`` outside of the ``Trainer`` for inference
      - use ``Trainer.predict``
-     - #6993
+     - `PR6993`_
 
    * - implemented ``on_load_checkpoint`` with a ``checkpoint`` only argument, as in ``Callback.on_load_checkpoint(checkpoint)``
      - now update the signature to include ``pl_module`` and ``trainer``, as in ``Callback.on_load_checkpoint(trainer, pl_module, checkpoint)``
-     - #7253
+     - `PR7253`_
 
    * - relied on ``pl.metrics``
      - now import separate package ``torchmetrics``
-     - https://torchmetrics.readthedocs.io/en/stable
+     - `torchmetrics`_
 
    * - accessed ``datamodule`` attribute of ``LightningModule``, that is ``model.datamodule``
      - now access ``Trainer.datamodule``, that is ``model.trainer.datamodule``
-     - #7168
+     - `PR7168`_
+
+
+.. _torchmetrics: https://torchmetrics.readthedocs.io/en/stable
+.. _pr7339: https://github.com/Lightning-AI/lightning/pull/7339
+.. _pr7323: https://github.com/Lightning-AI/lightning/pull/7323
+.. _pr7066: https://github.com/Lightning-AI/lightning/pull/7066
+.. _pr6146: https://github.com/Lightning-AI/lightning/pull/6146
+.. _pr6621: https://github.com/Lightning-AI/lightning/pull/6621
+.. _pr6349: https://github.com/Lightning-AI/lightning/pull/6349
+.. _pr6993: https://github.com/Lightning-AI/lightning/pull/6993
+.. _pr7253: https://github.com/Lightning-AI/lightning/pull/7253
+.. _pr7168: https://github.com/Lightning-AI/lightning/pull/7168