readme

README.md

@@ -1,8 +1,42 @@
-![Proxy-Lite Logo](assets/proxy-lite.png)
+<div align="center">
 
-A mini, open-weights version of our Proxy assistant.
+  <img src="assets/proxy-lite.png" alt="Proxy Lite logo" width="400" height="auto" />
+
+  <p>
+    A mini, open-weights version of our Proxy assistant.
+  </p>
+  
+  
+<!-- Badges -->
+<p>
+  <a href="https://github.com/convergence-ai/proxy-lite/contributors">
+    <img src="https://img.shields.io/github/contributors/convergence-ai/proxy-lite" alt="contributors" />
+  </a>
+  <a href="">
+    <img src="https://img.shields.io/github/last-commit/convergence-ai/proxy-lite" alt="last update" />
+  </a>
+  <a href="https://github.com/convergence-ai/proxy-lite/network/members">
+    <img src="https://img.shields.io/github/forks/convergence-ai/proxy-lite" alt="forks" />
+  </a>
+  <a href="https://github.com/convergence-ai/proxy-lite/stargazers">
+    <img src="https://img.shields.io/github/stars/convergence-ai/proxy-lite" alt="stars" />
+  </a>
+  <a href="https://github.com/convergence-ai/proxy-lite/issues/">
+    <img src="https://img.shields.io/github/issues/convergence-ai/proxy-lite" alt="open issues" />
+  </a>
+  <a href="https://github.com/convergence-ai/proxy-lite/blob/master/LICENSE">
+    <img src="https://img.shields.io/github/license/convergence-ai/proxy-lite.svg" alt="license" />
+  </a>
+</p>
+
+</div>
+
+
+
+
+
+![Proxy Lite Demo](assets/demo.gif)
 
-![Proxy-Lite Demo](assets/demo.gif)
 
 ---
 
@@ -37,17 +71,16 @@ playwright install
 ```bash
 proxy --help
 ```
-
-You can directly run the proxy with:
+You can directly run Proxy Lite on a task with:
 
 ```bash
 proxy "Book a table for 2 at an Italian restaurant in Kings Cross tonight at 7pm."
 ```
 
 
-### Proxy-Lite Endpoint
+### Proxy Lite Endpoint
 
-By default, Proxy-Lite will point to an endpoint set up on HuggingFace spaces. This is a demo endpoint and is not suitable for production use; it may be very slow when under heavy load.
+By default, Proxy Lite will point to an endpoint set up on HuggingFace spaces. This is a demo endpoint and is not suitable for production use; it may be very slow when under heavy load.
 
 We recommend hosting your own endpoint with vLLM, you can use the following command:
 
@@ -59,7 +92,11 @@ vllm serve --model convergence-ai/proxy-lite-7b \
     --port 8008 \
 ```
 
-You can set the `api_base` to point to your local endpoint when calling Proxy-Lite:
+The tool arguments are **very important** for parsing the tool calls from the model appropriately.
+
+> **Important:** To run this, install vLLM and transformers with `uv sync --all-extras`. `Qwen-2.5-VL` Support in `transformers` is not yet available in the latest release so is done from source.
+
+You can set the `api_base` to point to your local endpoint when calling Proxy Lite:
 
 ```bash
 proxy --api-base http://localhost:8008/v1 "Book a table...
@@ -70,7 +107,7 @@ or by setting the environment variable:
 export PROXY_LITE_API_BASE=http://localhost:8008/v1
 ```
 
-### Scaffolding Proxy-Lite in Python
+### Scaffolding Proxy Lite in Python
 
 We use the `RunnerConfig` to control the setup of the task.
 The library is designed to be modular and extendable, you can easily swap the environment, solver, or agent.
@@ -124,3 +161,4 @@ If you want to not use this set-of-marks approach, you can set the `no_pois_in_i
 
 
 
+