docs: add colab badges to examples (#1637)

Adds "Open in Colab" badges for all examples in docs
lightly-ai · Aug 20, 2024 · 1c9285a · 1c9285a
1 parent bc2d199
commit 1c9285a
Show file tree

Hide file tree

Showing 21 changed files with 186 additions and 0 deletions.
diff --git a/docs/source/examples/aim.rst b/docs/source/examples/aim.rst
@@ -19,6 +19,9 @@ Reference:
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/aim.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/aim.py
@@ -27,6 +30,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/aim.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/aim.py
@@ -35,6 +41,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/aim.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/barlowtwins.rst b/docs/source/examples/barlowtwins.rst
@@ -14,6 +14,9 @@ Reference:
 
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/barlowtwins.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/barlowtwins.py
@@ -22,6 +25,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/barlowtwins.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/barlowtwins.py
@@ -30,6 +36,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/barlowtwins.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/byol.rst b/docs/source/examples/byol.rst
@@ -13,6 +13,9 @@ Reference:
 
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/byol.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/byol.py
@@ -21,6 +24,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/byol.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/byol.py
@@ -29,6 +35,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/byol.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/dcl.rst b/docs/source/examples/dcl.rst
@@ -34,6 +34,9 @@ with DCL loss.
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/dcl.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/dcl.py
@@ -42,6 +45,9 @@ with DCL loss.
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/dcl.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/dcl.py
@@ -50,6 +56,9 @@ with DCL loss.
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/dcl.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/densecl.rst b/docs/source/examples/densecl.rst
@@ -16,6 +16,9 @@ Reference:
 
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/densecl.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/densecl.py
@@ -24,6 +27,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/densecl.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/densecl.py
@@ -32,6 +38,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/densecl.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/dino.rst b/docs/source/examples/dino.rst
@@ -12,6 +12,9 @@ Reference:
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/dino.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/dino.py
@@ -20,6 +23,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/dino.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/dino.py
@@ -28,6 +34,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/dino.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/fastsiam.rst b/docs/source/examples/fastsiam.rst
@@ -14,6 +14,9 @@ Reference:
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/fastsiam.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/fastsiam.py
@@ -22,6 +25,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/fastsiam.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/fastsiam.py
@@ -30,6 +36,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/fastsiam.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/mae.rst b/docs/source/examples/mae.rst
@@ -27,6 +27,9 @@ Reference:
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/mae.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/mae.py
@@ -35,6 +38,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/mae.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/mae.py
@@ -43,6 +49,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/mae.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/mmcr.rst b/docs/source/examples/mmcr.rst
@@ -13,6 +13,9 @@ Reference:
 
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/mmcr.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/mmcr.py
@@ -21,6 +24,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/mmcr.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/mmcr.py
@@ -29,6 +35,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/mmcr.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/moco.rst b/docs/source/examples/moco.rst
@@ -20,6 +20,9 @@ Tutorials:
 
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/moco.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/moco.py
@@ -28,6 +31,9 @@ Tutorials:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/moco.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/moco.py
@@ -36,6 +42,9 @@ Tutorials:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/moco.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/msn.rst b/docs/source/examples/msn.rst
@@ -20,6 +20,9 @@ See :ref:`PMSN` for a version of MSN for datasets with non-uniform class distrib
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/msn.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/msn.py
@@ -28,6 +31,9 @@ See :ref:`PMSN` for a version of MSN for datasets with non-uniform class distrib
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/msn.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/msn.py
@@ -36,6 +42,9 @@ See :ref:`PMSN` for a version of MSN for datasets with non-uniform class distrib
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/msn.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/nnclr.rst b/docs/source/examples/nnclr.rst
@@ -11,6 +11,9 @@ Reference:
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/nnclr.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/nnclr.py
@@ -19,6 +22,9 @@ Reference:
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/nnclr.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/nnclr.py
@@ -27,6 +33,9 @@ Reference:
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/nnclr.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::

diff --git a/docs/source/examples/pmsn.rst b/docs/source/examples/pmsn.rst
@@ -37,6 +37,9 @@ For PMSN, you can use the exact same code as for :ref:`msn` but change
 .. tabs::
     .. tab:: PyTorch
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch/pmsn.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch/pmsn.py
@@ -45,6 +48,9 @@ For PMSN, you can use the exact same code as for :ref:`msn` but change
 
     .. tab:: Lightning
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning/pmsn.ipynb
+
         This example can be run from the command line with::
 
             python lightly/examples/pytorch_lightning/pmsn.py
@@ -53,6 +59,9 @@ For PMSN, you can use the exact same code as for :ref:`msn` but change
 
     .. tab:: Lightning Distributed
 
+        .. image:: https://colab.research.google.com/assets/colab-badge.svg
+            :target: https://colab.research.google.com/github/lightly-ai/lightly/blob/master/examples/notebooks/pytorch_lightning_distributed/pmsn.ipynb
+
         This example runs on multiple gpus using Distributed Data Parallel (DDP)
         training with Pytorch Lightning. At least one GPU must be available on 
         the system. The example can be run from the command line with::