Docker (#4)

* update torch management
* gitignore notebooks
* add dockerfile & dockerignore
* add HF Space metadata in readme

.dockerignore

@@ -0,0 +1,11 @@
+.coverage
+.env
+.mypy_cache
+.pytest_cache
+.ruff_cache
+.venv
+.vscode
+
+*egg-info
+
+notebooks

.gitignore

@@ -10,3 +10,4 @@
 *egg-info
 
 __pycache__
+notebooks

Dockerfile

@@ -0,0 +1,43 @@
+
+FROM python:3.11-slim-bookworm AS base
+
+# --- Build stage ---
+
+FROM base AS builder
+
+COPY --from=ghcr.io/astral-sh/uv:0.8.3 / uv / uvx / bin/
+
+ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy
+
+WORKDIR /app
+
+COPY uv.lock pyproject.toml /app/
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync \
+    --frozen \
+    --extra torch-cpu \
+    --no-dev \
+    --no-install-project
+
+COPY . /app
+
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync \
+    --frozen \
+    --extra torch-cpu \
+    --no-dev
+
+# --- Final stage ---
+
+FROM base AS final
+
+COPY --from=builder /app /app
+
+ENV PATH="/app/.venv/bin:$PATH"
+
+EXPOSE 7860
+
+ENTRYPOINT [ "python", "-m", "rubik", "interface" ]
+
+CMD []

README.md

@@ -1,16 +1,32 @@
 # Rubik-Tensor
 
+---
+title: Rubik Tensor
+emoji: ⚡
+colorFrom: blue
+colorTo: blue
+sdk: docker
+pinned: false
+license: apache-2.0
+short_description: Interface for playing with Rubik cubes of any size
+---
+
+See the HF Space [JBAujogue/Rubik-Tensor](https://huggingface.co/spaces/JBAujogue/Rubik-Tensor)
 
 ## Setup
 
-This project uses `uv 0.7` as environment & dependency manager, and `python 3.11` as core interpreter. Install the project with
+This project uses `uv 0.8.3` as environment & dependency manager, and `python 3.11` as core interpreter. Install the project with
 
 ```shell
 uv venv
 (Activate env)
-uv sync
+uv sync --extra [extra]
 pre-commit install
 ```
+where `extra` should be one of the following:
+- `torch`: pytorch package released on pypi (cpu-only form non-linux systems, cuda-enabled for linux systems).
+- `torch-cpu`: cpu-only torch wheel. 
+- `torch-cu126`: cuda 12.6-compatible torch wheel. 
 
 ## Usage
 

notebooks/dev.ipynb

@@ -1,138 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "0",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "%load_ext autoreload\n",
-    "%autoreload 2"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "1",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "import copy\n",
-    "\n",
-    "import torch"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "2",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from rubik.cube import Cube\n",
-    "from rubik.action import build_actions_tensor\n",
-    "from rubik.interface.plot import CubeVisualizer"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "3",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "size = 3\n",
-    "\n",
-    "cube = Cube(size)\n",
-    "print(cube)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "4",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "cubis = copy.deepcopy(cube)\n",
-    "cubis.rotate(\"X2 X1i Y1i Z1i Y0 Z0i X2 X1i Y1i Z1i Y0 Z0i \")\n",
-    "\n",
-    "print(cubis)\n",
-    "print(cubis.history)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "5",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "visualizer = CubeVisualizer(size=cubis.size)\n",
-    "layout_args = {\"autosize\": False, \"width\": 600, \"height\": 600}\n",
-    "\n",
-    "visualizer(cubis.coordinates, cubis.state, cubis.size).update_layout(**layout_args).show()"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "6",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "cubis = copy.deepcopy(cube)\n",
-    "cubis.scramble(20000, seed=0)\n",
-    "print(cubis)\n",
-    "print(cubis.history)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "7",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "cubis = copy.deepcopy(cube)\n",
-    "cubis.rotate(\"X2 X1i Y1i Z1i Y0 Z0i X2 X1i Y1i Z1i Y0 Z0i \" * 1000)\n",
-    "print(cubis)\n",
-    "print(cubis.history)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "id": "8",
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "actions = build_actions_tensor(size)\n",
-    "\n",
-    "torch.gather(actions[0, 2, 0], 0, actions[0, 1, 1])"
-   ]
-  }
- ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "Rubik-Tensor",
-   "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.11.13"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 5
-}

pyproject.toml

@@ -3,16 +3,19 @@ name = "rubik-tensor"
 version = "0.1.0"
 description = "Add your description here"
 readme = "README.md"
-requires-python = ">=3.11,<3.12"
+requires-python = ">=3.11,<3.14"
 dependencies = [
     "fire>=0.7.0",
     "gradio>=5.38",
     "loguru>=0.7.3",
     "plotly>=6.2.0",
-    "pydantic>=2.11.7",
-    "torch>=2.7.1",
 ]
 
+[project.optional-dependencies]
+torch = [ "torch>=2.7.1" ]
+torch-cpu = [ "torch>=2.7.1" ]
+torch-cu126 = [ "torch>=2.7.1" ]
+
 [dependency-groups]
 dev = [
     "jupyter>=1.1.1",
@@ -25,13 +28,34 @@ dev = [
 
 [tool.uv]
 package = true
+conflicts = [
+    [
+        { extra = "torch" },
+        { extra = "torch-cpu" },
+        { extra = "torch-cu126" },
+    ],
+]
 
 [tool.uv.sources]
-torch = { index = "torch-cu126" }
+torch = [
+    { extra = "torch", index = "pypi" },
+    { extra = "torch-cpu", index = "torch-cpu" },
+    { extra = "torch-cu126", index = "torch-cu126" },
+]
+
+[[tool.uv.index]]
+name = "torch-cpu"
+url = "https://download.pytorch.org/whl/cpu"
+explicit = true
 
 [[tool.uv.index]]
 name = "torch-cu126"
 url = "https://download.pytorch.org/whl/cu126"
+explicit = true
+
+[[tool.uv.index]]
+name = "pypi"
+url = "https://pypi.python.org/simple"
 
 [tool.ruff]
 line-length = 120

src/rubik/interface/app.py

@@ -6,7 +6,7 @@ from rubik.cube import Cube
 from rubik.interface.plot import CubeVisualizer
 
 
-def app(default_size: int = 3):
+def app(default_size: int = 3, server_port: int = 7860):
     """
     Interface with the following features:
         - create a cube of the specified size.
@@ -62,5 +62,5 @@ def app(default_size: int = 3):
         scramble_btn.click(scramble_cube, inputs=num_moves).success(display_cube, None, plot)
         rotate_btn.click(rotate_cube, inputs=moves).success(display_cube, None, plot)
 
-    demo.launch()
+    demo.launch(server_name="0.0.0.0", server_port=server_port)
     return