tensorzero · GabrielBianconi · Jan 16, 2025 · Jan 15, 2025 · Jan 15, 2025 · Jan 16, 2025
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -85,6 +85,7 @@ Did you have something else in mind? Reach out on Slack or Discord and let us kn
 - Install Docker [→](https://docs.docker.com/get-docker/)
 - Install `uv` [→](https://docs.astral.sh/uv/)
 - Install Python (3.10+) (e.g. `uv python install 3.10` + )
+- Install Node.js (we use v22) and `npm` [→](https://nodejs.org/en)
 
 ### Tests
 
@@ -159,7 +160,32 @@ cargo test-unit
 
 #### Dashboard
 
-Refer to the instructions in `dashboard/README.md`.
+For development, the UI runs against hardcoded fixtures in `ui/fixtures/`.
+It depends on a running ClickHouse instance that has been initialized with the TensorZero data model.
+We include some fixture data as well in order to exercise some functionality.
+
+It also requires a one-time build of a WebAssembly module from Rust source code that is used to ensure consistent templating of messages across the gateway and UI.
+
+The steps below assume you are in the `ui/` directory.
+
+Here are the steps in order to run or test the UI assuming you have the prerequisites installed and this repository checked out:
+
+1. Install npm dependencies: `npm install --legacy-peer-deps cmdk`
+2. Build the WebAssembly module following instructions in `ui/app/utils/minijinja/README.md`.
+3. Create a `.env` file and set the following environment variables for the server:
+
+```bash
+OPENAI_API_KEY=<your-key>
+FIREWORKS_API_KEY=<your-key>
+FIREWORKS_ACCOUNT_ID=<your-account-id>
+CLICKHOUSE_URL=<your-clickhouse-url> # For testing, set to http://localhost:8123/tensorzero
+TENSORZERO_UI_CONFIG_PATH=<path-to-config-file> # For testing, set to ./fixtures/config/tensorzero.toml
+```
+
+4. Run the dependencies: `docker compose -f fixtures/docker-compose.yml up`
+
+With the dependencies running, you can run the tests with `npm run test`.
+Similarly, you can start a development server with `npm run dev`.
 
 ---
 

diff --git a/RELEASE_GUIDE.md b/RELEASE_GUIDE.md
@@ -33,7 +33,7 @@ docker buildx create \
   --bootstrap
 ```
 
-Every time you want to build the Docker container, you need to run:
+Every time you want to build the Docker container, you need to run from the root of the repository:
 
 ```bash
 DOCKER_BUILDKIT=1 docker buildx build \
@@ -50,6 +50,35 @@ DOCKER_BUILDKIT=1 docker buildx build \
 > [!IMPORTANT]
 > Make sure to replace the `XXXX.XX.X` placeholder with the actual version of the Docker container you are building.
 
+## UI Docker Container
+
+Before building the Docker container for the first time, you need to set up your container builder:
+
+```bash
+docker buildx create \
+  --name container-builder \
+  --driver docker-container \
+  --use \
+  --bootstrap
+```
+
+Every time you want to build the Docker container, you need to run from `ui/`:
+
+```bash
+DOCKER_BUILDKIT=1 docker buildx build \
+  --platform linux/amd64,linux/arm64 \
+  -t tensorzero/ui:latest \
+  -t tensorzero/ui:XXXX.XX.X \
+  -f Dockerfile \
+  --attest type=provenance,mode=max \
+  --attest type=sbom \
+  --push \
+  .
+```
+
+> [!IMPORTANT]
+> Make sure to replace the `XXXX.XX.X` placeholder with the actual version of the Docker container you are building.
+
 ## Documentation
 
 Make sure to merge every PR with the `merge-on-release` label.

diff --git a/clients/python/pyproject.toml b/clients/python/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "tensorzero"
-version = "2025.01.4"
+version = "2025.01.5"
 description = "The Python client for TensorZero"
 readme = "README.md"
 requires-python = ">=3.10"

diff --git a/clients/python/uv.lock b/clients/python/uv.lock
diff --git a/...best-of-n-sampling/config/functions/play_chess_board/chess_prompt/user_template.minijinja b/...best-of-n-sampling/config/functions/play_chess_board/chess_prompt/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_1/user_template.minijinja b/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_1/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_2/user_template.minijinja b/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_2/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_3/user_template.minijinja b/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_3/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_4/user_template.minijinja b/...st-of-n-sampling/config/functions/play_chess_board/chess_prompt_4/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/examples/chess-puzzles-best-of-n-sampling/docker-compose.yml b/examples/chess-puzzles-best-of-n-sampling/docker-compose.yml
@@ -39,3 +39,17 @@ services:
     depends_on:
       clickhouse:
         condition: service_healthy
+  ui:
+    container_name: tensorzero-ui-chess-puzzles-best-of-n-sampling
+    image: tensorzero/ui
+    volumes:
+      - ./config:/app/config:ro
+    environment:
+      - CLICKHOUSE_URL=http://tensorzero-clickhouse-chess-puzzles-best-of-n-sampling:8123/tensorzero
+    env_file:
+      - ${ENV_FILE:-.env}
+    ports:
+      - "4000:4000"
+    depends_on:
+      clickhouse:
+        condition: service_healthy
diff --git a/examples/chess-puzzles-best-of-n-sampling/requirements.txt b/examples/chess-puzzles-best-of-n-sampling/requirements.txt
@@ -2,6 +2,8 @@
 #    uv pip compile requirements.in -o requirements.txt
 anyio==4.6.0
     # via httpx
+appnope==0.1.4
+    # via ipykernel
 asttokens==2.4.1
     # via stack-data
 certifi==2024.8.30

diff --git a/...ture-of-n-sampling/config/functions/play_chess_board/chess_prompt/user_template.minijinja b/...ture-of-n-sampling/config/functions/play_chess_board/chess_prompt/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_1/user_template.minijinja b/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_1/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_2/user_template.minijinja b/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_2/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_3/user_template.minijinja b/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_3/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_4/user_template.minijinja b/...re-of-n-sampling/config/functions/play_chess_board/chess_prompt_4/user_template.minijinja
@@ -9,6 +9,6 @@ Here, capital letters represent white pieces and lowercase letters represent bla
 The legal moves are:
 {%- for move in legal_moves_san %}
 - {{ move }}
-{%- endfor -%}
+{%- endfor %}
 
 What's your next move?
diff --git a/examples/chess-puzzles-mixture-of-n-sampling/docker-compose.yml b/examples/chess-puzzles-mixture-of-n-sampling/docker-compose.yml
@@ -39,3 +39,17 @@ services:
     depends_on:
       clickhouse:
         condition: service_healthy
+  ui:
+    container_name: tensorzero-ui-chess-puzzles-mixture-of-n-sampling
+    image: tensorzero/ui
+    volumes:
+      - ./config:/app/config:ro
+    environment:
+      - CLICKHOUSE_URL=http://tensorzero-chess-puzzles-mixture-of-n-sampling:8123/tensorzero
+    env_file:
+      - ${ENV_FILE:-.env}
+    ports:
+      - "4000:4000"
+    depends_on:
+      clickhouse:
+        condition: service_healthy
diff --git a/examples/chess-puzzles-mixture-of-n-sampling/requirements.txt b/examples/chess-puzzles-mixture-of-n-sampling/requirements.txt
@@ -2,6 +2,8 @@
 #    uv pip compile requirements.in -o requirements.txt
 anyio==4.6.0
     # via httpx
+appnope==0.1.4
+    # via ipykernel
 asttokens==2.4.1
     # via stack-data
 certifi==2024.8.30

diff --git a/examples/gsm8k-custom-recipe-dspy/docker-compose.yml b/examples/gsm8k-custom-recipe-dspy/docker-compose.yml
@@ -38,3 +38,17 @@ services:
     depends_on:
       clickhouse:
         condition: service_healthy
+  ui:
+    container_name: tensorzero-ui-gsm8k-custom-recipe-dspy
+    image: tensorzero/ui
+    volumes:
+      - ./config:/app/config:ro
+    environment:
+      - CLICKHOUSE_URL=http://tensorzero-clickhouse-gsm8k-custom-recipe-dspy:8123/tensorzero
+    env_file:
+      - ${ENV_FILE:-.env}
+    ports:
+      - "4000:4000"
+    depends_on:
+      clickhouse:
+        condition: service_healthy
diff --git a/examples/gsm8k-custom-recipe-dspy/requirements.in b/examples/gsm8k-custom-recipe-dspy/requirements.in
@@ -4,5 +4,6 @@ dspy-ai
 ipykernel
 notebook
 pandas
+scipy
 tensorzero
 tqdm
diff --git a/examples/gsm8k-custom-recipe-dspy/requirements.txt b/examples/gsm8k-custom-recipe-dspy/requirements.txt
@@ -18,6 +18,8 @@ anyio==4.4.0
     #   httpx
     #   jupyter-server
     #   openai
+appnope==0.1.4
+    # via ipykernel
 argon2-cffi==23.1.0
     # via jupyter-server
 argon2-cffi-bindings==21.2.0
@@ -87,12 +89,10 @@ frozenlist==1.4.1
     # via
     #   aiohttp
     #   aiosignal
-fsspec[http]==2024.6.1
+fsspec==2024.6.1
     # via
     #   datasets
     #   huggingface-hub
-greenlet==3.1.1
-    # via sqlalchemy
 h11==0.14.0
     # via httpcore
 httpcore==1.0.5
@@ -136,7 +136,7 @@ json5==0.9.25
     # via jupyterlab-server
 jsonpointer==3.0.0
     # via jsonschema
-jsonschema[format-nongpl]==4.23.0
+jsonschema==4.23.0
     # via
     #   jupyter-events
     #   jupyterlab-server
@@ -224,6 +224,7 @@ numpy==2.1.1
     #   optuna
     #   pandas
     #   pyarrow
+    #   scipy
 openai==1.44.0
     # via dspy-ai
 optuna==4.0.0
@@ -328,8 +329,12 @@ rpds-py==0.20.0
     # via
     #   jsonschema
     #   referencing
+scipy==1.15.1
+    # via -r requirements.in
 send2trash==1.8.3
     # via jupyter-server
+setuptools==75.8.0
+    # via jupyterlab
 six==1.16.0
     # via
     #   asttokens

diff --git a/examples/haiku-hidden-preferences/docker-compose.yml b/examples/haiku-hidden-preferences/docker-compose.yml
@@ -23,7 +23,7 @@ services:
       start_interval: 1s
       timeout: 1s
   gateway:
-    container_name: tensorzero-gateway
+    container_name: tensorzero-gateway-haiku-hidden-preferences
     image: tensorzero/gateway
     volumes:
       - ./config:/app/config:ro
@@ -38,3 +38,18 @@ services:
     depends_on:
       clickhouse:
         condition: service_healthy
+
+  ui:
+    container_name: tensorzero-ui-haiku-hidden-preferences
+    image: tensorzero/ui
+    volumes:
+      - ./config:/app/config:ro
+    environment:
+      - CLICKHOUSE_URL=http://tensorzero-clickhouse-haiku-hidden-preferences:8123/tensorzero
+    env_file:
+      - ${ENV_FILE:-.env}
+    ports:
+      - "4000:4000"
+    depends_on:
+      clickhouse:
+        condition: service_healthy
diff --git a/examples/haiku-hidden-preferences/haiku.ipynb b/examples/haiku-hidden-preferences/haiku.ipynb
@@ -38,7 +38,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "tensorzero_client = AsyncTensorZeroGateway(\"http://localhost:3000\", timeout=5.0)"
+    "tensorzero_client = AsyncTensorZeroGateway(\"http://localhost:3000\", timeout=15.0)"
    ]
   },
   {
@@ -110,7 +110,7 @@
     "            episode_id=haiku_result.episode_id,\n",
     "        )\n",
     "    except Exception as e:\n",
-    "        print(e)\n",
+    "        print(f\"Error occurred: {type(e).__name__}: {e}\")\n",
     "        return None\n",
     "\n",
     "    score = judge_result.output.parsed[\"score\"]\n",

diff --git a/examples/ner-dicl/docker-compose.yml b/examples/ner-dicl/docker-compose.yml
@@ -38,3 +38,18 @@ services:
     depends_on:
       clickhouse:
         condition: service_healthy
+
+  ui:
+    container_name: tensorzero-ui-ner-dicl
+    image: tensorzero/ui
+    volumes:
+      - ./config:/app/config:ro
+    environment:
+      - CLICKHOUSE_URL=http://tensorzero-clickhouse-ner-dicl:8123/tensorzero
+    env_file:
+      - ${ENV_FILE:-.env}
+    ports:
+      - "4000:4000"
+    depends_on:
+      clickhouse:
+        condition: service_healthy