README for UI-Mate-9B

README.md

@@ -0,0 +1,198 @@
+---
+base_model: Qwen/Qwen3.5-9B
+library_name: transformers
+license: apache-2.0
+pipeline_tag: image-text-to-text
+tags:
+- computer-use-agent
+- gui-agent
+- multimodal
+- vision-language
+- desktop-agent
+- pyautogui
+- osworld
+- windowsagentarena
+---
+
+<div align="center">
+
+# UI-Mate-9B
+
+### UI-Mate: Advancing Open-Weight Foundation GUI Agents with In-Context Demonstrations
+
+**Show the workflow once. Let the agent adapt it to the task at hand.**
+
+Tencent HY Frontier · Multimodal Agent Team
+
+[Project Page](https://ui-mate.github.io/) ·
+[GitHub](https://github.com/Tencent/UI-Mate)
+
+</div>
+
+## Overview
+
+**UI-Mate-9B** is an open-weight foundation GUI agent for long-horizon work across applications and operating systems. It observes live screenshots, reasons over the visible state, and produces structured keyboard and mouse actions for native desktop interaction.
+
+UI-Mate supports two complementary modes:
+
+- **General computer use:** execute tasks from natural-language instructions and live screenshots.
+- **Demonstration-guided computer use:** adapt a reusable workflow extracted from one successful demonstration to a new task.
+
+A demonstration is treated as guidance rather than a fixed action script. The model continues to re-plan from the live interface when the content, layout, or application state differs.
+
+## Model Details
+
+- **Parameters:** 9B
+- **Base model:** [Qwen3.5-9B](https://huggingface.co/Qwen/Qwen3.5-9B)
+- **Input:** task instruction, screenshots, interaction history, and optional demonstration context
+- **Output:** reasoning, a concise action description, and structured computer-use tool calls
+- **Action space:** mouse, keyboard, scrolling, waiting, user interaction, and task completion
+- **Training:** supervised fine-tuning followed by online reinforcement learning in executable GUI environments
+- **License:** Apache-2.0
+
+UI-Mate is an agent checkpoint rather than a standalone visual-chat model. We recommend using the official prompt, response parser, and interaction harness from the [UI-Mate repository](https://github.com/Tencent/UI-Mate).
+
+## Highlights
+
+- Strong general computer-use performance at an efficient 9B scale.
+- Long-horizon execution across multiple applications.
+- One-shot procedural learning from demonstrations.
+- Live-screen grounding instead of coordinate replay.
+- Structured actions compatible with `pyautogui`.
+- OpenAI-compatible serving and client interface.
+
+## Evaluation
+
+### Instruction-only execution
+
+| Benchmark | UI-Mate-9B |
+| --- | ---: |
+| OSWorld-Verified · average score | **66.2** |
+| WindowsAgentArena · average score | **61.7** |
+| OSWorkerBench · strict success | **34.00** |
+| OSWorkerBench · progress | **66.55** |
+
+See the [project page](https://ui-mate.github.io/) for evaluation details and updates.
+
+## Quick Start
+
+### 1. Serve the model with vLLM
+
+vLLM automatically downloads the checkpoint from Hugging Face Hub on first launch.
+
+```bash
+pip install -U vllm openai pillow
+
+vllm serve tencent/UI-Mate-9B \
+    --trust-remote-code \
+    --served-model-name UI_Mate \
+    --port 8000 \
+    --tensor-parallel-size 1 \
+    --gpu-memory-utilization 0.85 \
+    --mm-encoder-tp-mode data \
+    --chat-template-content-format openai \
+    --limit-mm-per-prompt '{"image":6,"video":0}'
+```
+
+The default agent retains five screenshots in context. The server must therefore admit at least six images because the newest screenshot arrives before the oldest one is collapsed.
+
+Confirm that the endpoint exposes the expected model name:
+
+```bash
+curl -s http://127.0.0.1:8000/v1/models
+```
+
+### 2. Run the reference examples
+
+```bash
+git clone https://github.com/Tencent/UI-Mate.git
+cd UI-Mate
+
+python examples/run_agent.py \
+    --base-url http://127.0.0.1:8000/v1
+```
+
+Run a complete recorded trajectory:
+
+```bash
+python examples/run_agent.py \
+    --replay \
+    --base-url http://127.0.0.1:8000/v1
+```
+
+Or provide your own screenshot:
+
+```bash
+python examples/run_agent.py \
+    --image /path/to/screen.png \
+    --instruction "Export this spreadsheet as HTML and open it in Chrome"
+```
+
+### 3. Use the Python agent
+
+```python
+from agents.ui_mate_agent import UIMateAgent
+
+agent = UIMateAgent(
+    base_url="http://127.0.0.1:8000/v1",
+    model="UI_Mate",
+)
+
+with open("screen.png", "rb") as f:
+    response, actions = agent.predict(
+        "Install the autoDocstring extension in VS Code.",
+        {"screenshot": f.read()},
+    )
+
+print(response)
+print(actions)
+
+# Reset the interaction history before starting a new task.
+agent.reset()
+```
+
+The model reasons in a normalized `1000 × 1000` coordinate space. The reference agent automatically rescales predicted coordinates to the original screenshot resolution.
+
+## Demonstration-Guided Execution
+
+A UI-Mate demonstration records screenshots immediately before and after each keyboard or pointer action. The trace is then:
+
+1. normalized into a consistent action-and-frame representation;
+2. annotated with observations, intent, actions, and verification evidence;
+3. segmented into named subtasks with completion criteria; and
+4. injected at inference time as a compact workflow for the active subtask.
+
+The live screenshot remains authoritative throughout execution. For demonstration recording and management, see the [UI-Mate project page](https://ui-mate.github.io/).
+
+## Intended Use and Limitations
+
+UI-Mate-9B is intended for research and development of screenshot-based GUI agents in controlled desktop environments.
+
+Its behavior can be affected by application versions, screen layouts, display scaling, latency, and unexpected UI state. Benchmark performance does not guarantee reliable execution in arbitrary environments, and the model requires an external runtime to execute its predicted actions.
+
+## Safety
+
+Computer-use agents can make mistakes, encounter prompt injection, or trigger consequential actions.
+
+- Prefer isolated or disposable environments.
+- Avoid unattended, high-stakes, or destructive workflows.
+- Require human confirmation before sensitive operations.
+- Monitor the interaction trajectory and verify the resulting application state.
+- Do not treat a model-reported success as proof that the intended outcome was achieved.
+
+## License
+
+UI-Mate is released under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). Third-party components remain subject to their respective licenses. See the repository [LICENSE](https://github.com/Tencent/UI-Mate/blob/main/LICENSE) for details.
+
+## Citation
+
+Citation details will be updated when the technical report is publicly released.
+
+```bibtex
+@article{uimate2026,
+  title   = {UI-Mate: Advancing Open-Weight Foundation GUI Agents with In-Context Demonstrations},
+  author  = {{Tencent HY Frontier Multimodal Agent Team}},
+  journal = {arXiv preprint},
+  year    = {2026}
+}
+```