browsergym-workarena 0.4.3__py3-none-any.whl → 0.5.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. browsergym/workarena/__init__.py +1 -1
  2. browsergym/workarena/api/system_properties.py +66 -0
  3. browsergym/workarena/config.py +9 -1
  4. browsergym/workarena/data_files/task_configs/report_retrieval_minmax_task.json +1 -1
  5. browsergym/workarena/data_files/task_configs/report_retrieval_value_task.json +1 -1
  6. browsergym/workarena/install.py +138 -50
  7. browsergym/workarena/instance.py +124 -17
  8. browsergym/workarena/tasks/dashboard.py +34 -4
  9. browsergym/workarena/tasks/scripts/generate_dashboard_configs.py +11 -2
  10. browsergym/workarena/tasks/scripts/{navigation.py → generate_navigation_tasks.py} +4 -1
  11. browsergym/workarena/tasks/scripts/knowledge.py +6 -4
  12. {browsergym_workarena-0.4.3.dist-info → browsergym_workarena-0.5.0.dist-info}/METADATA +9 -21
  13. {browsergym_workarena-0.4.3.dist-info → browsergym_workarena-0.5.0.dist-info}/RECORD +16 -15
  14. {browsergym_workarena-0.4.3.dist-info → browsergym_workarena-0.5.0.dist-info}/WHEEL +0 -0
  15. {browsergym_workarena-0.4.3.dist-info → browsergym_workarena-0.5.0.dist-info}/entry_points.txt +0 -0
  16. {browsergym_workarena-0.4.3.dist-info → browsergym_workarena-0.5.0.dist-info}/licenses/LICENSE +0 -0
{browsergym_workarena-0.4.3.dist-info → browsergym_workarena-0.5.0.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: browsergym-workarena
3
- Version: 0.4.3
3
+ Version: 0.5.0
4
4
  Summary: WorkArena benchmark for BrowserGym
5
5
  Project-URL: homepage, https://github.com/ServiceNow/WorkArena
6
6
  Author: Léo Boisvert, Alex Drouin, Maxime Gasse, Alex Lacoste, Manuel Del Verme, Megh Thakkar
@@ -16,6 +16,7 @@ Requires-Python: >3.7
16
16
  Requires-Dist: browsergym-core>=0.2
17
17
  Requires-Dist: english-words>=2.0.1
18
18
  Requires-Dist: faker>=24.8.0
19
+ Requires-Dist: huggingface-hub>=0.23
19
20
  Requires-Dist: numpy>=1.14
20
21
  Requires-Dist: requests>=2.31
21
22
  Requires-Dist: tenacity>=8.2.3
@@ -65,28 +66,19 @@ https://github.com/ServiceNow/WorkArena/assets/2374980/68640f09-7d6f-4eb1-b556-c
65
66
 
66
67
  ## Getting Started
67
68
 
68
- 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.
69
+ 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.
69
70
 
70
- ### a) Create a ServiceNow Developer Instance
71
+ ### a) Gain Access to ServiceNow Instances
71
72
 
72
- 1. Go to https://developer.servicenow.com/ and create an account.
73
- 2. Click on `Request an instance` and select the `Washington` release (initializing the instance will take a few minutes)
74
- 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_.
75
- 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)
73
+ 1. Navigate to https://huggingface.co/datasets/ServiceNow/WorkArena-Instances.
74
+ 2. Fill the form, accept the terms to gain access to the gated repository and wait for approval.
75
+ 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).
76
76
 
77
- 5. You should now see your URL and credentials. Based on this information, set the following environment variables:
78
- * `SNOW_INSTANCE_URL`: The URL of your ServiceNow developer instance
79
- * `SNOW_INSTANCE_UNAME`: The username, should be "admin"
80
- * `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.
81
- 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).
82
-
83
- **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.
84
-
85
- ### b) Install WorkArena and Initialize your Instance
77
+ ### b) Install WorkArena
86
78
 
87
79
  Run the following command to install WorkArena in the [BrowswerGym](https://github.com/servicenow/browsergym) environment:
88
80
  ```
89
- pip install browsergym
81
+ pip install browsergym-workarena
90
82
  ```
91
83
 
92
84
  Then, install [Playwright](https://github.com/microsoft/playwright):
@@ -94,10 +86,6 @@ Then, install [Playwright](https://github.com/microsoft/playwright):
94
86
  playwright install
95
87
  ```
96
88
 
97
- Finally, run this command in a terminal to upload the benchmark data to your ServiceNow instance:
98
- ```
99
- workarena-install
100
- ```
101
89
  Your installation is now complete! 🎉
102
90
 
103
91
 
{browsergym_workarena-0.4.3.dist-info → browsergym_workarena-0.5.0.dist-info}/RECORD RENAMED
@@ -1,7 +1,7 @@
1
- browsergym/workarena/__init__.py,sha256=7s59CgTTqAr4Dh9CTw2u4ycENp60nhASAYG_x3b2oVs,6289
2
- browsergym/workarena/config.py,sha256=L8f-EgCHwWQtXoa9ZmYBWc16_JfBRrQUjz1YB6rZiIk,8522
3
- browsergym/workarena/install.py,sha256=iEps7IkXFObJaQlE9t78LUFvoqsfKsQbcLLvuFIfBK8,39728
4
- browsergym/workarena/instance.py,sha256=-w21jT-lnXVWtUolJbuTKsPuULvq-Qa-j9FwdfNJrmE,4343
1
+ browsergym/workarena/__init__.py,sha256=j1vzWGs3kd_e-AU-jyudHdtLCA7NrjkBdPuQTe9oBcs,6289
2
+ browsergym/workarena/config.py,sha256=8Ahq35y5-VKsbf9QN0mP4zAZGiK_lZR1-tVL5rHF-qs,8835
3
+ browsergym/workarena/install.py,sha256=sgj8h0VXMqXue7xrFrvlXHm2XryvyWEf6v_SJSUd9yc,43197
4
+ browsergym/workarena/instance.py,sha256=lEi6ESlTwbucE_hvAtlE59eStshvnJqIbX8pnAmjPas,8073
5
5
  browsergym/workarena/utils.py,sha256=mD6RqVua-m1-mKM1RGGlUEu1s6un0ZI9a5ZTPN7g1hY,3199
6
6
  browsergym/workarena/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
7
  browsergym/workarena/api/category.py,sha256=4oiwPnRas0ZWCdky76zhNpu_9PfB_HmhnFa_DJZyGfA,2084
@@ -15,6 +15,7 @@ browsergym/workarena/api/problem.py,sha256=QEr9uwUCOvVZcz7Or9bKkb7aCIrP7LSPulvfO
15
15
  browsergym/workarena/api/report.py,sha256=nNSTcM4mKE9GXjlm787iAlK5Q71oQbWdUcVvl0GlpeE,6903
16
16
  browsergym/workarena/api/requested_items.py,sha256=g0X0sA1v8bAQzz9jfpATqSctUNNOTD547D6EH5Z4sw0,1678
17
17
  browsergym/workarena/api/requests.py,sha256=z2vQTTkm1HR04_d_pce6jopuN--Oh0gUaT-YhrVa9-8,4148
18
+ browsergym/workarena/api/system_properties.py,sha256=-DysHuUTfH82tkQGOalNdtql-2yeGWEH5QBaYTpBKh4,1648
18
19
  browsergym/workarena/api/ui_themes.py,sha256=9H8HhnqHWt0CA5X5E1sokkXSCYYxtWZvhNFcXn3e90s,836
19
20
  browsergym/workarena/api/user.py,sha256=mLx8r4RFVAuw66514xniv5sn_O4kwjAsVf-iCQC9aJk,4821
20
21
  browsergym/workarena/api/utils.py,sha256=sulU1rC6jiCyDVwn5PqPK0AC-6m-GJS_4Crzar6pENU,5000
@@ -63,8 +64,8 @@ browsergym/workarena/data_files/task_configs/order_ipad_pro_task.json,sha256=gR5
63
64
  browsergym/workarena/data_files/task_configs/order_loaner_laptop_task.json,sha256=g_BDRnvn5wm7rRcISdmT197-4MDe2QfsWmY5FnCG7Tc,183107
64
65
  browsergym/workarena/data_files/task_configs/order_sales_laptop_task.json,sha256=6IGZg5NE2pjrUeDyOajk3Z2F4TCjqBRLS9VPh7lEu5Q,707828
65
66
  browsergym/workarena/data_files/task_configs/order_standard_laptop_task.json,sha256=qSh8lM13RgQyaKAzNIwAM0B84iZvSOgY1FQEAGeawaA,516203
66
- browsergym/workarena/data_files/task_configs/report_retrieval_minmax_task.json,sha256=cVG6wknVqj9tl4hTVmhyv0fTD-0r8B3OQFgK-Bf5rwc,112107
67
- browsergym/workarena/data_files/task_configs/report_retrieval_value_task.json,sha256=ee1LhCMwM5VCw1OodCGmwyQWSkMhpvckFNCR34AxsMA,327974
67
+ browsergym/workarena/data_files/task_configs/report_retrieval_minmax_task.json,sha256=RwuWHi8W_cgWGF37-cf4mLx5A7WEr4Io8R8kV-HqjpM,116571
68
+ browsergym/workarena/data_files/task_configs/report_retrieval_value_task.json,sha256=GKAw70L_00SoDSgr4anJmipyulkfy2krdxzC_VsKZig,339350
68
69
  browsergym/workarena/data_files/task_configs/sort_asset_list_task.json,sha256=CxGupg15OFAT8z0ddieTJnIOQ1xHqCJJkqPgZI1sJNA,44721
69
70
  browsergym/workarena/data_files/task_configs/sort_change_request_list_task.json,sha256=dmYPzs86MGzD-j_h8bEiynH9LWdfm12a2Z5PkSJ7-dc,45862
70
71
  browsergym/workarena/data_files/task_configs/sort_hardware_list_task.json,sha256=iE5RmskNfiw-6CajMgmB75oxyJ8qu5JIjJugHf1NNPQ,45127
@@ -76,7 +77,7 @@ browsergym/workarena/human_eval/tool.py,sha256=SwPqArNnvEeOPLRgem6kwl8ho345o-1f3
76
77
  browsergym/workarena/tasks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
77
78
  browsergym/workarena/tasks/base.py,sha256=Ikh_A5I9_9acHFQCcnVMEnlBg3u3QHQD2I_NbGvD6SE,6411
78
79
  browsergym/workarena/tasks/comp_building_block.py,sha256=Lg3KbAWrxzAHe5XbPN6L8bvdu7mfJpmBvI7jXeSDwKE,194
79
- browsergym/workarena/tasks/dashboard.py,sha256=KFqenTFCbhndZL4rPouK3DJcapoCYaph4O4E3aLhDaI,34493
80
+ browsergym/workarena/tasks/dashboard.py,sha256=6ohpC40zpK1NLlfYM7RIqeenmuEuoIL9wOBUdG3JTFI,35842
80
81
  browsergym/workarena/tasks/form.py,sha256=_s07yZ-zcZbi5v6VK6km1BPzUfIFfMEVWFm56QhoznM,64141
81
82
  browsergym/workarena/tasks/knowledge.py,sha256=kANjlC7DpptMbRlUlZGdDjqZeWIwwyJzozV58qEA6KU,13751
82
83
  browsergym/workarena/tasks/list.py,sha256=7eb9F1JooLzFGIciul2_E1bCmNyBo5AzOPozO1p1HaM,55778
@@ -117,11 +118,11 @@ browsergym/workarena/tasks/compositional/utils/infeasible_configs.py,sha256=iByO
117
118
  browsergym/workarena/tasks/compositional/utils/knapsack.py,sha256=T5zBuJsphOmLwIz64imX7h5KlMxTrXPHcRAE32nv9Rk,9155
118
119
  browsergym/workarena/tasks/scripts/README.md,sha256=-jOtGf9k2zoBhrBkesmfDnr9-s0PhOEi0KWI9xfOw1s,296
119
120
  browsergym/workarena/tasks/scripts/extract_all_menu_items.py,sha256=vPxa5Y06RXiQC6YaR30B9ap_Zu34hTddxohLKqKmjzw,10044
120
- browsergym/workarena/tasks/scripts/generate_dashboard_configs.py,sha256=r2cDLR1n1pnf5m_8XITNx93zuYt5JaBVaiut4OqYlkc,10063
121
+ browsergym/workarena/tasks/scripts/generate_dashboard_configs.py,sha256=vduPAX3XXuzQNw7KDRtgIxwqsg6pVvWTRc253PZh32M,10516
121
122
  browsergym/workarena/tasks/scripts/generate_forms.py,sha256=wnqXE1b5eQdwQB0ZqsqQS5z9VNKyObUnYoYVvsq4sM0,3695
122
- browsergym/workarena/tasks/scripts/knowledge.py,sha256=Qrv3AY9i6vjXhitDFITGjNjMvOL6H7FLKCJR8hA6Qdo,1259
123
+ browsergym/workarena/tasks/scripts/generate_navigation_tasks.py,sha256=M2MNf4NZnfgI2j0QmCfTosNU-KKhcj8URcX_eAzo28Y,1018
124
+ browsergym/workarena/tasks/scripts/knowledge.py,sha256=Wj2_Gnvx7wincXgLt-T8wzIqFTiECti9yT03m2jtnjI,1387
123
125
  browsergym/workarena/tasks/scripts/list.py,sha256=Cy9pvUHqKRwSH5yWT746ZW9TMGZC9qrBzvPKZDGWYTM,4803
124
- browsergym/workarena/tasks/scripts/navigation.py,sha256=2GIIGoW6Ad2YpwX99_MTuLoijSk-EgsjfRNiRaYaitE,853
125
126
  browsergym/workarena/tasks/scripts/service_catalog.py,sha256=_jllQWEfiUidRgiX-hFbdrTRKmiufvQO4RJ558h8HuQ,4879
126
127
  browsergym/workarena/tasks/scripts/validate.py,sha256=Q4SXNEtjSN8Pm6_Fz8ddOv5hbSaxclzii_Bm3dSHveE,7555
127
128
  browsergym/workarena/tasks/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -131,8 +132,8 @@ browsergym/workarena/tasks/utils/js_utils.js,sha256=n97fmY2Jkr59rEcQSuSbCnn1L2ZN
131
132
  browsergym/workarena/tasks/utils/private_tasks.py,sha256=r7Z9SnBMuZdZ2i-tK6eULj0q8hclANXFSzdLl49KYHI,2128
132
133
  browsergym/workarena/tasks/utils/string.py,sha256=ir5_ASD9QSFMZ9kuHo2snSXRuSfv_wROH6nxBLOTP4I,330
133
134
  browsergym/workarena/tasks/utils/utils.py,sha256=xQD-njEwgN7qxfn1dLBN8MYfd3kl3TuVfpmI1yxML9k,955
134
- browsergym_workarena-0.4.3.dist-info/METADATA,sha256=XP57A1zokK8y5ijhsmtqT32BVyWiGH_rA36UDCQspWg,11698
135
- browsergym_workarena-0.4.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
136
- browsergym_workarena-0.4.3.dist-info/entry_points.txt,sha256=1lCeAbQFCcU6UTFwS5QIA3TKhT2P9ZabaZKT7sIShKc,137
137
- browsergym_workarena-0.4.3.dist-info/licenses/LICENSE,sha256=sZLFiZHo_1hcxXRhXUDnQYVATUuWwRCdQjBxqxNnNEs,579
138
- browsergym_workarena-0.4.3.dist-info/RECORD,,
135
+ browsergym_workarena-0.5.0.dist-info/METADATA,sha256=RxpMe8nqLAg9bsPHMxq5C7KXVg-qLJ7w_AcZrZWVzbY,10533
136
+ browsergym_workarena-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
137
+ browsergym_workarena-0.5.0.dist-info/entry_points.txt,sha256=1lCeAbQFCcU6UTFwS5QIA3TKhT2P9ZabaZKT7sIShKc,137
138
+ browsergym_workarena-0.5.0.dist-info/licenses/LICENSE,sha256=sZLFiZHo_1hcxXRhXUDnQYVATUuWwRCdQjBxqxNnNEs,579
139
+ browsergym_workarena-0.5.0.dist-info/RECORD,,