[Docs] add Colab badge to missing notebooks

ai4co · Sep 3, 2024 · e15326f · e15326f
1 parent c335e06
commit e15326f
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 2 deletions.
diff --git a/examples/advanced/1-hydra-config.ipynb b/examples/advanced/1-hydra-config.ipynb
@@ -6,6 +6,8 @@
    "source": [
     "# Hydra Configuration\n",
     "\n",
+    "<a href=\"https://colab.research.google.com/github/ai4co/rl4co/blob/main/examples/advanced/1-hydra-config.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>\n",
+    "\n",
     "[Hydra](https://hydra.cc/docs/intro/) makes it extremely convenient to configure projects with lots of parameter settings like the RL4CO library. \n",
     "\n",
     "While you don't need Hydra to use RL4CO, it is recommended to use it for your own projects to make it easier to manage the configuration of your experiments.\n",

diff --git a/examples/advanced/3-local-search.ipynb b/examples/advanced/3-local-search.ipynb
@@ -8,7 +8,9 @@
     "\n",
     "In this notebook, we will show how to improve the solution at hand using local search and other techniques. Here we solve TSP and use 2-opt to improve the solution. You can check how the improvement works for other problems in each Env's `local_search` method. \n",
     "\n",
-    "Note that this notebook is based on [`1-quickstart`](../1-quickstart.ipynb) and we use the checkpoint file from it. If you haven't checked it yet, we recommend you to check it first."
+    "Note that this notebook is based on [`1-quickstart`](../1-quickstart.ipynb) and we use the checkpoint file from it. If you haven't checked it yet, we recommend you to check it first.\n",
+    "\n",
+    "<a href=\"https://colab.research.google.com/github/ai4co/rl4co/blob/main/examples/advanced/3-local-search.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>"
    ]
   },
   {

diff --git a/examples/datasets/1-test-on-tsplib.ipynb b/examples/datasets/1-test-on-tsplib.ipynb
@@ -10,6 +10,11 @@
     "\n",
     "[TSPLib](http://comopt.ifi.uni-heidelberg.de/software/TSPLIB95/) is a library of sample instances for the TSP (and related problems) from various sources and of various types. In the TSPLib, there are several problems, including *TSP, HCP, ATSP*, etc. In this notebook, we will focus on testing the model on the TSP problem.\n",
     "\n",
+    "\n",
+    "\n",
+    "<a href=\"https://colab.research.google.com/github/ai4co/rl4co/blob/main/examples/datasets/1-test-on-tsplib.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>\n",
+    "\n",
+    "\n",
     "## Before we start\n",
     "\n",
     "Before we test the model on TSPLib dataset, we need to prepare the dataset first by the following steps:\n",

diff --git a/examples/datasets/2-test-on-cvrplib.ipynb b/examples/datasets/2-test-on-cvrplib.ipynb
@@ -10,6 +10,8 @@
     "\n",
     "[VRPLIB](http://vrp.galgos.inf.puc-rio.br/index.php/en/) is a collection of instances related to the CVRP, which is a classic optimization challenge in the field of logistics and transportation. \n",
     "\n",
+    "<a href=\"https://colab.research.google.com/github/ai4co/rl4co/blob/main/examples/datasets/2-test-on-cvrplib.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>\n",
+    "\n",
     "## Before we start\n",
     "\n",
     "To use the VRPLib, we strongly recomment to use the Python `vrplib` tool:\n",

diff --git a/examples/other/1-mtvrp.ipynb b/examples/other/1-mtvrp.ipynb
@@ -6,6 +6,8 @@
    "source": [
     "# MTVRP: Multi-task VRP environment\n",
     "\n",
+    "<a href=\"https://colab.research.google.com/github/ai4co/rl4co/blob/main/examples/other/1-mtvrp.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>\n",
+    "\n",
     "\n",
     "This environment can handle _any_ of the following variants:\n",
     "\n",

diff --git a/examples/other/3-data-generator-distributions.ipynb b/examples/other/3-data-generator-distributions.ipynb
@@ -6,7 +6,9 @@
    "source": [
     "# Generating data in RL4CO\n",
     "\n",
-    "RL4CO allows for easily generating data from different distributions for CO problems"
+    "RL4CO allows for easily generating data from different distributions for CO problems\n",
+    "\n",
+    "<a href=\"https://colab.research.google.com/github/ai4co/rl4co/blob/main/examples/other/3-data-generator-distributions.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>\n"
    ]
   },
   {