docs: add mkdocs-jupyter

docs/requirements.txt

@@ -1,2 +1,3 @@
 mkdocs-material
 mkdocstrings[python]
+mkdocs-jupyter

docs/user_guide.ipynb

@@ -0,0 +1,64 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Furiosa Model Zoo User Guide\n",
+    "모델 주는 FuriosaAI NPU를 사용해서 가속할 수 있는 모델들을 쉽게 사용할 수 있도록 모아놓은 프로젝트입니다.\n",
+    "먼저, 사용 가능한 모델들을 살펴보겠습니다."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "['EfficientNetB0', 'EfficientNetV2s', 'ResNet50', 'SSDMobileNet', 'SSDResNet34', 'YOLOv5l', 'YOLOv5m']\n"
+     ]
+    }
+   ],
+   "source": [
+    "from furiosa.models import vision\n",
+    "\n",
+    "\n",
+    "print(dir(vision))"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "!furiosa-models list"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "models",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.9.17"
+  },
+  "orig_nbformat": 4
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

mkdocs.yml

@@ -20,6 +20,7 @@ repo_url: https://github.com/furiosa-ai/furiosa-models
 nav:
 - Overview: index.md
 - getting_started.md
+- user_guide.ipynb
 - model_object.md
 - command_tool.md
 - Models:
@@ -50,6 +51,9 @@ markdown_extensions:
 
 plugins:
 - search
+- mkdocs-jupyter:
+    execute: true
+    ignore: ["examples/*.py"]
 - mkdocstrings:
     default_handler: python
     handlers: