[Docs] Add Google Colab

ai4co · Jul 25, 2024 · 54af084 · 54af084
1 parent cb0ab1e
commit 54af084
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # RouteFinder
 
 [![arXiv](https://img.shields.io/badge/arXiv-2406.15007-b31b1b.svg)](https://arxiv.org/abs/2406.15007) [![OpenReview](https://img.shields.io/badge/⚖️-OpenReview-8b1b16)](https://openreview.net/forum?id=hCiaiZ6e4G) [![Slack](https://img.shields.io/badge/slack-chat-611f69.svg?logo=slack)](https://join.slack.com/t/rl4co/shared_invite/zt-1ytz2c1v4-0IkQ8NQH4TRXIX8PrRmDhQ)
-[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT)[![Test](https://github.com/ai4co/routefinder/actions/workflows/tests.yml/badge.svg)](https://github.com/ai4co/routefinder/actions/workflows/tests.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT)[![Test](https://github.com/ai4co/routefinder/actions/workflows/tests.yml/badge.svg)](https://github.com/ai4co/routefinder/actions/workflows/tests.yml)<a href="https://colab.research.google.com/github/ai4co/routefinder/blob/main/examples/1.quickstart.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"></a>
 
 _Towards Foundation Models for Vehicle Routing Problems_
 

diff --git a/examples/1.quickstart.ipynb b/examples/1.quickstart.ipynb
@@ -4,9 +4,27 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# RouteFinder\n",
+    "# RouteFinder Quickstart Notebook\n",
     "\n",
-    "Quickstart Notebook"
+    "<a href=\"https://colab.research.google.com/github/ai4co/routefinder/blob/main/examples/1.quickstart.ipynb\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"></a>"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Uncomment and run the below cell for Google Colab"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# !git clone https://github.com/ai4co/routefinder.git\n",
+    "# %cd routefinder\n",
+    "# !pip install -e .[solver]"
    ]
   },
   {