Duplicate from julien-c/nbconvert

Co-authored-by: Julien Chaumond <[email protected]>

.gitattributes

@@ -0,0 +1,34 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1 @@
+.env/

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+	"editor.formatOnSave": true,
+	"python.formatting.provider": "black"
+}

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.10
+
+WORKDIR /code
+
+COPY ./requirements.txt /code/requirements.txt
+
+RUN pip install --no-cache-dir --upgrade -r /code/requirements.txt
+
+COPY . .
+
+CMD ["uvicorn", "--host", "0.0.0.0", "--port", "7860", "app:app"]

README.md

@@ -0,0 +1,12 @@
+---
+title: nbconvert
+emoji: 💪
+colorFrom: purple
+colorTo: purple
+sdk: docker
+pinned: false
+license: mit
+duplicated_from: julien-c/nbconvert
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

app.py

@@ -0,0 +1,91 @@
+from typing import Literal
+import httpx
+import nbformat
+from nbformat import NotebookNode, ValidationError
+from nbconvert import HTMLExporter
+from starlette.applications import Starlette
+from starlette.exceptions import HTTPException
+from starlette.responses import FileResponse, JSONResponse, HTMLResponse
+from starlette.requests import Request
+from starlette.routing import Route
+
+client = httpx.AsyncClient()
+html_exporter = HTMLExporter(template_name="lab")
+
+
+async def homepage(_):
+    return FileResponse("static/index.html")
+
+
+async def healthz(_):
+    return JSONResponse({"success": True})
+
+
+def convert(s: str, theme: Literal["light", "dark"], debug_info: str) -> str:
+    # Capture potential validation error:
+    try:
+        notebook_node: NotebookNode = nbformat.reads(
+            s,
+            as_version=nbformat.current_nbformat,
+        )
+    except nbformat.reader.NotJSONError:
+        print(400, f"Notebook is not JSON. {debug_info}")
+        raise HTTPException(400, f"Notebook is not JSON.")
+    except ValidationError as e:
+        print(
+            400,
+            f"Notebook is invalid according to nbformat: {e}. {debug_info}",
+        )
+        raise HTTPException(
+            400,
+            f"Notebook is invalid according to nbformat: {e}.",
+        )
+
+    print(f"Input: nbformat v{notebook_node.nbformat}.{notebook_node.nbformat_minor}")
+    html_exporter.theme = theme
+    body, _ = html_exporter.from_notebook_node(notebook_node)
+    # TODO(customize or simplify template?)
+    # TODO(also check source code for jupyter/nbviewer)
+    return body
+
+
+async def convert_from_url(req: Request):
+    url = req.query_params.get("url")
+    theme = "dark" if req.query_params.get("theme") == "dark" else "light"
+
+    if not url:
+        raise HTTPException(400, "Param url is missing")
+    print("\n===", url)
+    r = await client.get(
+        url,
+        follow_redirects=True,
+        # httpx no follow redirect by default
+    )
+    if r.status_code != 200:
+        raise HTTPException(
+            400, f"Got an error {r.status_code} when fetching remote file"
+        )
+
+    return HTMLResponse(content=convert(r.text, theme=theme, debug_info=f"url={url}"))
+
+
+async def convert_from_upload(req: Request):
+    theme = "dark" if req.query_params.get("theme") == "dark" else "light"
+
+    s = (await req.body()).decode("utf-8")
+    return HTMLResponse(
+        content=convert(
+            s, theme=theme, debug_info=f"upload_from={req.headers.get('user-agent')}"
+        )
+    )
+
+
+app = Starlette(
+    debug=False,
+    routes=[
+        Route("/", homepage),
+        Route("/healthz", healthz),
+        Route("/convert", convert_from_url),
+        Route("/upload", convert_from_upload, methods=["POST"]),
+    ],
+)

requirements.txt

@@ -0,0 +1,5 @@
+httpx==0.23.3
+starlette==0.23.1
+ipython==8.8.0
+nbconvert==7.2.8
+uvicorn==0.20.0

static/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "useTabs": true
+}

static/index.html

@@ -0,0 +1,85 @@
+<!DOCTYPE html>
+<html>
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<script src="https://cdn.tailwindcss.com"></script>
+	</head>
+	<body>
+		<div class="container mx-auto py-4 dark:text-white">
+			<h1 class="text-3xl font-bold text-center">nbconvert-server</h1>
+			<p class="text-center">
+				An internal API used as a backend for notebook rendering on the Hub
+			</p>
+			<svg class="mx-auto mb-8" width="32" height="32" viewBox="0 0 24 24">
+				<path
+					fill="#888888"
+					fill-rule="evenodd"
+					d="M16.48 14h4.02a2.5 2.5 0 1 0 0-5H6.618a1 1 0 0 1-.894-.553l-.448-.894A1 1 0 0 0 4.382 7H2.517a1 1 0 0 0-.92 1.394l2.143 5a1 1 0 0 0 .92.606h3.863a1 1 0 0 1 .928 1.371L8.55 17.63A1 1 0 0 0 9.477 19h2.042a1 1 0 0 0 .781-.375l3.4-4.25a1 1 0 0 1 .78-.375zM9.5 8h4.75L12.3 5.4a1 1 0 0 0-.8-.4H9.618a1 1 0 0 0-.894 1.447L9.5 8z"
+					clip-rule="evenodd"
+				/>
+			</svg>
+
+			<div class="w-96 mx-auto">
+				<p>Sample notebooks:</p>
+				<ul class="list-disc">
+					<li>
+						climategan (LFS-stored > 10MB)
+						<a
+							target="_blank"
+							class="underline"
+							href="/convert?url=https://huggingface.co/spaces/NimaBoscarino/climategan/resolve/main/notebooks/plot_metrics.ipynb"
+						>
+							html</a
+						>,
+						<a
+							target="_blank"
+							class="underline"
+							href="https://huggingface.co/spaces/NimaBoscarino/climategan/blob/main/notebooks/plot_metrics.ipynb"
+						>
+							on Hub
+						</a>
+					</li>
+					<li>
+						Fake_News_Classificaton.ipynb (stored in raw git)
+						<a
+							target="_blank"
+							class="underline"
+							href="/convert?url=https://huggingface.co/pceiyos/fake_news_detection_nlp/resolve/main/Fake_News_Classificaton.ipynb"
+						>
+							html</a
+						>,
+						<a
+							target="_blank"
+							class="underline"
+							href="https://huggingface.co/pceiyos/fake_news_detection_nlp/blob/main/Fake_News_Classificaton.ipynb"
+						>
+							on Hub
+						</a>
+					</li>
+					<li>
+						Dall-e mini (specific revision)
+						<a
+							target="_blank"
+							class="underline"
+							href="/convert?url=https://huggingface.co/spaces/dalle-mini/dalle-mini/resolve/63679e968109278c5f0169100b1755bbda9f4bc6/tools/inference/inference_pipeline.ipynb"
+						>
+							html</a
+						>,
+						<a
+							target="_blank"
+							class="underline"
+							href="https://huggingface.co/spaces/dalle-mini/dalle-mini/blob/63679e968109278c5f0169100b1755bbda9f4bc6/tools/inference/inference_pipeline.ipynb"
+						>
+							on Hub
+						</a>
+					</li>
+				</ul>
+			</div>
+
+			<div class="text-xs text-gray-500 text-center mt-10 mb-4">
+				ping @julien-c if anything looks wrong
+			</div>
+		</div>
+	</body>
+</html>