browsergym-workarena 0.4.3__tar.gz → 0.5.0__tar.gz

browsergym_workarena-0.5.0/CITATION.cff

@@ -0,0 +1,81 @@
+cff-version: 1.2.0
+message: "If you use WorkArena in your research, please cite both of the following papers."
+title: "WorkArena"
+date-released: 2024-03-12
+url: "https://github.com/ServiceNow/workarena"
+license: "Apache-2.0"
+
+authors:
+  - family-names: Drouin
+    given-names: Alexandre
+  - family-names: Gasse
+    given-names: Maxime
+  - family-names: Caccia
+    given-names: Massimo
+  - family-names: Laradji
+    given-names: Issam H.
+  - family-names: Del Verme
+    given-names: Manuel
+  - family-names: Marty
+    given-names: Tom
+  - family-names: Vazquez
+    given-names: David
+  - family-names: Chapados
+    given-names: Nicolas
+  - family-names: Lacoste
+    given-names: Alexandre
+
+preferred-citation:
+  - type: inproceedings
+    title: "WorkArena: How Capable are Web Agents at Solving Common Knowledge Work Tasks?"
+    authors:
+      - family-names: Drouin
+        given-names: Alexandre
+      - family-names: Gasse
+        given-names: Maxime
+      - family-names: Caccia
+        given-names: Massimo
+      - family-names: Laradji
+        given-names: Issam H.
+      - family-names: Del Verme
+        given-names: Manuel
+      - family-names: Marty
+        given-names: Tom
+      - family-names: Vazquez
+        given-names: David
+      - family-names: Chapados
+        given-names: Nicolas
+      - family-names: Lacoste
+        given-names: Alexandre
+    booktitle: "Proceedings of the 41st International Conference on Machine Learning (ICML)"
+    series: "Proceedings of Machine Learning Research"
+    volume: 235
+    pages: "11642–11662"
+    year: 2024
+    url: "https://proceedings.mlr.press/v235/drouin24a.html"
+
+  - type: inproceedings
+    title: "WorkArena++: Towards Compositional Planning and Reasoning-based Common Knowledge Work Tasks"
+    authors:
+      - family-names: Boisvert
+        given-names: Léo
+      - family-names: Thakkar
+        given-names: Megh
+      - family-names: Gasse
+        given-names: Maxime
+      - family-names: Caccia
+        given-names: Massimo
+      - family-names: Le Sellier De Chezelles
+        given-names: Thibault
+      - family-names: Cappart
+        given-names: Quentin
+      - family-names: Chapados
+        given-names: Nicolas
+      - family-names: Lacoste
+        given-names: Alexandre
+      - family-names: Drouin
+        given-names: Alexandre
+    booktitle: "Advances in Neural Information Processing Systems 37 (NeurIPS 2024), Datasets & Benchmarks Track"
+    year: 2024
+    url: "https://proceedings.neurips.cc/paper_files/paper/2024/hash/0b82662b6c32e887bb252a74d8cb2d5e-Paper-Datasets_and_Benchmarks_Track.pdf"
+    doi: "10.52202/079017-0195"

{browsergym_workarena-0.4.3 → browsergym_workarena-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: browsergym-workarena
-Version: 0.4.3
+Version: 0.5.0
 Summary: WorkArena benchmark for BrowserGym
 Project-URL: homepage, https://github.com/ServiceNow/WorkArena
 Author: Léo Boisvert, Alex Drouin, Maxime Gasse, Alex Lacoste, Manuel Del Verme, Megh Thakkar
@@ -16,6 +16,7 @@ Requires-Python: >3.7
 Requires-Dist: browsergym-core>=0.2
 Requires-Dist: english-words>=2.0.1
 Requires-Dist: faker>=24.8.0
+Requires-Dist: huggingface-hub>=0.23
 Requires-Dist: numpy>=1.14
 Requires-Dist: requests>=2.31
 Requires-Dist: tenacity>=8.2.3
@@ -65,28 +66,19 @@ https://github.com/ServiceNow/WorkArena/assets/2374980/68640f09-7d6f-4eb1-b556-c
 
 ## Getting Started
 
-To setup WorkArena, you will need to get your own ServiceNow instance, install our Python package, and upload some data to your instance. Follow the steps below to achieve this.
+To setup WorkArena, you will need to gain access to ServiceNow instances and install our Python package locally. Follow the steps below to achieve this.
 
-### a) Create a ServiceNow Developer Instance
+### a) Gain Access to ServiceNow Instances
 
-1. Go to https://developer.servicenow.com/ and create an account.
-2. Click on `Request an instance` and select the `Washington` release (initializing the instance will take a few minutes)
-3. Once the instance is ready, you should see your instance URL and credentials. If not, click _Return to the Developer Portal_, then navigate to _Manage instance password_ and click _Reset instance password_.
-4. Change the role of the user to admin in yoyr instance parameters ![image](https://github.com/user-attachments/assets/6f0fbf8e-f40f-411a-84cb-fead93d85f60)
+1. Navigate to https://huggingface.co/datasets/ServiceNow/WorkArena-Instances.
+2. Fill the form, accept the terms to gain access to the gated repository and wait for approval.
+3. Ensure that the machine where you will run WorkArena is [authenticated with Hugging Face](https://huggingface.co/docs/hub/en/datasets-polars-auth) (e.g., via huggingface-cli login or the HUGGING_FACE_HUB_TOKEN environment variable).
 
-5. You should now see your URL and credentials. Based on this information, set the following environment variables:
-    * `SNOW_INSTANCE_URL`: The URL of your ServiceNow developer instance
-    * `SNOW_INSTANCE_UNAME`: The username, should be "admin"
-    * `SNOW_INSTANCE_PWD`: The password, make sure you place the value in quotes "" and be mindful of [escaping special shell characters](https://onlinelinuxtools.com/escape-shell-characters). Running `echo $SNOW_INSTANCE_PWD` should print the correct password.
-6. Log into your instance via a browser using the admin credentials. Close any popup that appears on the main screen (e.g., agreeing to analytics).
-
-**Warning:** Feel free to look around the platform, but please make sure you revert any changes (e.g., changes to list views, pinning some menus, etc.) as these changes will be persistent and affect the benchmarking process.
-
-### b) Install WorkArena and Initialize your Instance
+### b) Install WorkArena
 
 Run the following command to install WorkArena in the [BrowswerGym](https://github.com/servicenow/browsergym) environment:
 ```
-pip install browsergym
+pip install browsergym-workarena
 ```
 
 Then, install [Playwright](https://github.com/microsoft/playwright):
@@ -94,10 +86,6 @@ Then, install [Playwright](https://github.com/microsoft/playwright):
 playwright install
 ```
 
-Finally, run this command in a terminal to upload the benchmark data to your ServiceNow instance:
-```
-workarena-install
-```
 Your installation is now complete! 🎉
 
 

{browsergym_workarena-0.4.3 → browsergym_workarena-0.5.0}/README.md

@@ -41,28 +41,19 @@ https://github.com/ServiceNow/WorkArena/assets/2374980/68640f09-7d6f-4eb1-b556-c
 
 ## Getting Started
 
-To setup WorkArena, you will need to get your own ServiceNow instance, install our Python package, and upload some data to your instance. Follow the steps below to achieve this.
+To setup WorkArena, you will need to gain access to ServiceNow instances and install our Python package locally. Follow the steps below to achieve this.
 
-### a) Create a ServiceNow Developer Instance
+### a) Gain Access to ServiceNow Instances
 
-1. Go to https://developer.servicenow.com/ and create an account.
-2. Click on `Request an instance` and select the `Washington` release (initializing the instance will take a few minutes)
-3. Once the instance is ready, you should see your instance URL and credentials. If not, click _Return to the Developer Portal_, then navigate to _Manage instance password_ and click _Reset instance password_.
-4. Change the role of the user to admin in yoyr instance parameters ![image](https://github.com/user-attachments/assets/6f0fbf8e-f40f-411a-84cb-fead93d85f60)
+1. Navigate to https://huggingface.co/datasets/ServiceNow/WorkArena-Instances.
+2. Fill the form, accept the terms to gain access to the gated repository and wait for approval.
+3. Ensure that the machine where you will run WorkArena is [authenticated with Hugging Face](https://huggingface.co/docs/hub/en/datasets-polars-auth) (e.g., via huggingface-cli login or the HUGGING_FACE_HUB_TOKEN environment variable).
 
-5. You should now see your URL and credentials. Based on this information, set the following environment variables:
-    * `SNOW_INSTANCE_URL`: The URL of your ServiceNow developer instance
-    * `SNOW_INSTANCE_UNAME`: The username, should be "admin"
-    * `SNOW_INSTANCE_PWD`: The password, make sure you place the value in quotes "" and be mindful of [escaping special shell characters](https://onlinelinuxtools.com/escape-shell-characters). Running `echo $SNOW_INSTANCE_PWD` should print the correct password.
-6. Log into your instance via a browser using the admin credentials. Close any popup that appears on the main screen (e.g., agreeing to analytics).
-
-**Warning:** Feel free to look around the platform, but please make sure you revert any changes (e.g., changes to list views, pinning some menus, etc.) as these changes will be persistent and affect the benchmarking process.
-
-### b) Install WorkArena and Initialize your Instance
+### b) Install WorkArena
 
 Run the following command to install WorkArena in the [BrowswerGym](https://github.com/servicenow/browsergym) environment:
 ```
-pip install browsergym
+pip install browsergym-workarena
 ```
 
 Then, install [Playwright](https://github.com/microsoft/playwright):
@@ -70,10 +61,6 @@ Then, install [Playwright](https://github.com/microsoft/playwright):
 playwright install
 ```
 
-Finally, run this command in a terminal to upload the benchmark data to your ServiceNow instance:
-```
-workarena-install
-```
 Your installation is now complete! 🎉
 
 

{browsergym_workarena-0.4.3 → browsergym_workarena-0.5.0}/requirements.txt

@@ -5,3 +5,4 @@ numpy>=1.14
 requests>=2.31
 tenacity>=8.2.3  # only used in cheat() -> move to tests?
 tqdm>=4.66.2
+huggingface_hub>=0.23

{browsergym_workarena-0.4.3 → browsergym_workarena-0.5.0}/src/browsergym/workarena/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.4.3"
+__version__ = "0.5.0"
 
 import inspect
 from logging import warning

browsergym_workarena-0.5.0/src/browsergym/workarena/api/system_properties.py

@@ -0,0 +1,66 @@
+from .utils import table_api_call
+
+
+def set_sys_property(instance, property_name: str, value: str):
+    """
+    Set a sys_property in the instance.
+
+    Parameters:
+    -----------
+    instance: SNowInstance
+        The instance to set the property in
+    property_name: str
+        The name of the property to set
+    value: str
+        The value to set for the property
+
+    """
+
+    property = table_api_call(
+        instance=instance,
+        table="sys_properties",
+        params={"sysparm_query": f"name={property_name}", "sysparm_fields": "sys_id"},
+    )["result"]
+
+    if not property:
+        property_sysid = ""
+        method = "POST"
+    else:
+        property_sysid = "/" + property[0]["sys_id"]
+        method = "PUT"
+
+    property = table_api_call(
+        instance=instance,
+        table=f"sys_properties{property_sysid}",
+        method=method,
+        json={"name": property_name, "value": value},
+    )
+
+    # Verify that the property was updated
+    assert property["result"]["value"] == value, f"Error setting {property_name}."
+
+
+def get_sys_property(instance, property_name: str) -> str:
+    """
+    Get a sys_property from the instance.
+
+    Parameters:
+    -----------
+    instance: SNowInstance
+        The instance to get the property from
+    property_name: str
+        The name of the property to get
+
+    Returns:
+    --------
+    str
+        The value of the property
+
+    """
+    property_value = table_api_call(
+        instance=instance,
+        table="sys_properties",
+        params={"sysparm_query": f"name={property_name}", "sysparm_fields": "value"},
+    )["result"][0]["value"]
+
+    return property_value

{browsergym_workarena-0.4.3 → browsergym_workarena-0.5.0}/src/browsergym/workarena/config.py

@@ -1,4 +1,6 @@
 from importlib import resources
+from json import load as json_load
+from os.path import exists
 
 from ..workarena import data_files
 from ..workarena.tasks import utils
@@ -9,6 +11,12 @@ SNOW_BROWSER_TIMEOUT = 30000  # Milliseconds
 SNOW_JS_UTILS_FILEPATH = str(resources.files(utils).joinpath("js_utils.js"))
 SNOW_SUPPORTED_RELEASES = ["washingtondc"]
 
+# Hugging Face dataset containing available instances
+INSTANCE_REPO_ID = "ServiceNow/WorkArena-Instances"
+INSTANCE_REPO_FILENAME = "instances.json"
+INSTANCE_REPO_TYPE = "dataset"
+INSTANCE_XOR_SEED = "x3!+-9mi#nhlo%a02$9hna{]"
+
 # Path to the Menu navigation task configuration
 ALL_MENU_PATH = str(resources.files(data_files).joinpath("task_configs/all_menu.json"))
 
@@ -224,4 +232,4 @@ EXPECTED_REQUEST_ITEM_FORM_FIELDS_PATH = str(
 
 # Report date filter patch flag
 REPORT_PATCH_FLAG = "WORKARENA_DATE_FILTER_PATCH"
-REPORT_DATE_FILTER = "2025-07-15"
+REPORT_FILTER_PROPERTY = "workarena.report.filter.config"