Merge branch 'main' into streamlit

LICENSE

@@ -1,201 +1,3 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+Creative Commons Attribution-NonCommercial 4.0 International
 
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+This work is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License. To view a copy of this license, visit https://creativecommons.org/licenses/by-nc/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

Makefile

@@ -1,6 +1,7 @@
 .PHONY: proxy
 
 proxy:
+	pip install uv
 	uv venv --python 3.11 --python-preference managed
 	uv sync
 	uv pip install -e .

README.md

@@ -1,14 +1,46 @@
-![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" style="margin-bottom: 20px;" />
 
-![Proxy-Lite Demo](assets/demo.gif)
+  <h2>
+    A mini, open-weights, version of our Proxy assistant.
+  </h2>
 
----
 
-## Getting Started
+<!-- 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>
 
-### Installation
+</div>
+
+
+
+
+<div align="center">
+     <img src="assets/demo.gif" alt="Proxy Lite Demo" />
+</div>
+
+
+
+## Installation
 
 Clone the repository: 
 
@@ -25,6 +57,7 @@ make proxy
 Or do it manually:
 
 ```bash
+pip install uv
 uv venv --python 3.11 --python-preference managed
 uv sync
 uv pip install -e .
@@ -32,22 +65,21 @@ playwright install
 ```
 
 
-### Usage
+## Usage
 
 ```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 +91,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,6 +106,58 @@ or by setting the environment variable:
 export PROXY_LITE_API_BASE=http://localhost:8008/v1
 ```
 
+### 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.
+
+Example:
+```python
+import asyncio
+from proxy_lite import Runner, RunnerConfig
+
+config = RunnerConfig.from_dict(
+    {
+        "environment": {
+            "name": "webbrowser",
+            "homepage": "https://www.google.com",
+            "headless": True, # Don't show the browser
+        },
+        "solver": {
+            "name": "simple",
+            "agent": {
+                "name": "proxy_lite",
+                "client": {
+                    "name": "convergence",
+                    "model_id": "convergence-ai/proxy-lite",
+                    "api_base": "https://convergence-ai-demo-api.hf.space/v1",
+                },
+            },
+        },
+        "max_steps": 50,
+        "action_timeout": 1800,
+        "environment_timeout": 1800,
+        "task_timeout": 18000,
+        "logger_level": "DEBUG",
+    },
+)
+
+proxy = Runner(config=config)
+result = asyncio.run(
+    proxy.run("Book a table for 2 at an Italian restaurant in Kings Cross tonight at 7pm.")
+)
+```
+
+### Webbrowser Environment
+
+The `webbrowser` environment is a simple environment that uses the `playwright` library to navigate the web.
+
+We launch a Chromium browser and navigate to the `homepage` provided in the `RunnerConfig`.
+
+Actions in an environment are defined through available tool calls, which in the browser case are set as default in the `BrowserTool` class. This allows the model to click, type, etc. at relevant `mark_id` elements on the page. These elements are extracted using JavaScript injected into the page in order to make interaction easier for the models. 
+
+If you want to not use this set-of-marks approach, you can set the `no_pois_in_image` flag to `True`, and the `include_poi_text` flag to `False` in the `EnvironmentConfig`. This way the model will only see the original image, and not the annotated image with these points-of-interest (POIs). In this case, you would want to update the `BrowserTool` to interact with pixel coordinates instead of the `mark_id`s.
+
 
 
 

pyproject.toml

@@ -8,20 +8,27 @@ dependencies = [
     "omegaconf>=2.3.0",
     "openai>=1.61.1",
     "opencv-python>=4.11.0.86",
+    "opencv-python-headless>=4.11.0.86",
     "playwright-stealth>=1.0.6",
     "playwright>=1.50.0",
     "pydantic>=2.10.6",
     "rich>=13.9.4",
     "setuptools>=75.8.0",
     "tenacity>=9.0.0",
-    "torch>=2.6.0",
-    "torchvision>=0.21.0",
+    "torch>=2.5.1",
+    "torchvision>=0.20.1",
     "streamlit>=1.40.2",
 ]
 
 [project.scripts]
 proxy = "proxy_lite.cli:main"
 
+[project.optional-dependencies]
+serving = [
+    "transformers",
+    "vllm==0.7.2",
+]
+
 [build-system]
 requires = ["setuptools"]
 build-backend = "setuptools.build_meta"
@@ -52,3 +59,6 @@ extend-immutable-calls = [
     "fastapi.params.Query",
 ]
 
+[tool.uv.sources]
+transformers = { git = "https://github.com/huggingface/transformers.git", rev = "336dc69d63d56f232a183a3e7f52790429b871ef" }
+

src/proxy_lite/environments/webbrowser.py

@@ -28,6 +28,7 @@ class WebBrowserEnvironmentConfig(BaseEnvironmentConfig):
     browserbase_timeout: int = 7200
     headless: bool = True
     keep_original_image: bool = False
+    no_pois_in_image: bool = False
 
 
 @Environments.register_environment("webbrowser")
@@ -78,8 +79,10 @@ class WebBrowserEnvironment(BaseEnvironment):
         original_img, annotated_img = await self.browser.screenshot(
             delay=self.config.screenshot_delay,
         )
-
-        base64_image = base64.b64encode(annotated_img).decode("utf-8")
+        if self.config.no_pois_in_image:
+            base64_image = base64.b64encode(original_img).decode("utf-8")
+        else:
+            base64_image = base64.b64encode(annotated_img).decode("utf-8")
 
         html_content = await self.browser.current_page.content() if self.config.include_html else None