cua-computer 0.1.23__py3-none-any.whl → 0.1.24__py3-none-any.whl

computer/interface/models.py

@@ -7,6 +7,9 @@ NavigationKey = Literal['pagedown', 'pageup', 'home', 'end', 'left', 'right', 'u
 # Special key literals
 SpecialKey = Literal['enter', 'esc', 'tab', 'space', 'backspace', 'del']
 
+# Modifier key literals
+ModifierKey = Literal['ctrl', 'alt', 'shift', 'win', 'command', 'option']
+
 # Function key literals
 FunctionKey = Literal['f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10', 'f11', 'f12']
 
@@ -35,6 +38,14 @@ class Key(Enum):
     BACKSPACE = 'backspace'
     DELETE = 'del'
     
+    # Modifier keys
+    ALT = 'alt'
+    CTRL = 'ctrl'
+    SHIFT = 'shift'
+    WIN = 'win'
+    COMMAND = 'command'
+    OPTION = 'option'
+    
     # Function keys
     F1 = 'f1'
     F2 = 'f2'
@@ -73,14 +84,27 @@ class Key(Enum):
             'escape': cls.ESCAPE,
             'esc': cls.ESC,
             'delete': cls.DELETE,
-            'del': cls.DELETE
+            'del': cls.DELETE,
+            # Modifier key mappings
+            'alt': cls.ALT,
+            'ctrl': cls.CTRL,
+            'control': cls.CTRL,
+            'shift': cls.SHIFT,
+            'win': cls.WIN,
+            'windows': cls.WIN,
+            'super': cls.WIN,
+            'command': cls.COMMAND,
+            'cmd': cls.COMMAND,
+            '⌘': cls.COMMAND,
+            'option': cls.OPTION,
+            '⌥': cls.OPTION,
         }
         
         normalized = key.lower().strip()
         return key_mapping.get(normalized, key)
 
 # Combined key type
-KeyType = Union[Key, NavigationKey, SpecialKey, FunctionKey, str]
+KeyType = Union[Key, NavigationKey, SpecialKey, ModifierKey, FunctionKey, str]
 
 class AccessibilityWindow(TypedDict):
     """Information about a window in the accessibility tree."""

{cua_computer-0.1.23.dist-info → cua_computer-0.1.24.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cua-computer
-Version: 0.1.23
+Version: 0.1.24
 Summary: Computer-Use Interface (CUI) framework powering Cua
 Author-Email: TryCua <gh@trycua.com>
 Requires-Python: >=3.10
@@ -85,30 +85,78 @@ Refer to this notebook for a step-by-step guide on how to use the Computer-Use I
 
 ## Using the Gradio Computer UI
 
-The computer module includes a Gradio UI for creating and sharing demonstration data. The UI provides built-in integration with Hugging Face Datasets for sharing demonstrations and incorporating them into CUA ML pipelines.
+The computer module includes a Gradio UI for creating and sharing demonstration data. We make it easy for people to build community datasets for better computer use models with an upload to Huggingface feature.
 
 ```bash
 # Install with UI support
 pip install "cua-computer[ui]"
 ```
 
+> **Note:** For precise control of the computer, we recommend using VNC or Screen Sharing instead of the Computer Gradio UI.
 
-<details open>
-<summary>View demonstration video</summary>
-<video src="https://github.com/user-attachments/assets/7c683b58-f04d-4e8c-b63f-6ef36e9637d5" controls width="600"></video>
-</details>
+### Building and Sharing Demonstrations with Huggingface
 
-> **Note:** For precise control of the computer, we recommend using VNC or Screen Sharing instead of the Computer Gradio UI.
+Follow these steps to contribute your own demonstrations:
+
+#### 1. Set up Huggingface Access
 
+Set your HF_TOKEN in a .env file or in your environment variables:
+
+```bash
+# In .env file
+HF_TOKEN=your_huggingface_token
+```
 
-### Launch the UI
+#### 2. Launch the Computer UI
 
 ```python
 # launch_ui.py
 from computer.ui.gradio.app import create_gradio_ui
+from dotenv import load_dotenv
+load_dotenv('.env')
 
 app = create_gradio_ui()
 app.launch(share=False)
 ```
 
 For examples, see [Computer UI Examples](../../examples/computer_ui_examples.py)
+
+#### 3. Record Your Tasks
+
+<details open>
+<summary>View demonstration video</summary>
+<video src="https://github.com/user-attachments/assets/de3c3477-62fe-413c-998d-4063e48de176" controls width="600"></video>
+</details>
+
+Record yourself performing various computer tasks using the UI.
+
+#### 4. Save Your Demonstrations
+
+<details open>
+<summary>View demonstration video</summary>
+<video src="https://github.com/user-attachments/assets/5ad1df37-026a-457f-8b49-922ae805faef" controls width="600"></video>
+</details>
+
+Save each task by picking a descriptive name and adding relevant tags (e.g., "office", "web-browsing", "coding").
+
+#### 5. Record Additional Demonstrations
+
+Repeat steps 3 and 4 until you have a good amount of demonstrations covering different tasks and scenarios.
+
+#### 6. Upload to Huggingface
+
+<details open>
+<summary>View demonstration video</summary>
+<video src="https://github.com/user-attachments/assets/c586d460-3877-4b5f-a736-3248886d2134" controls width="600"></video>
+</details>
+
+Upload your dataset to Huggingface by:
+- Naming it as `{your_username}/{dataset_name}`
+- Choosing public or private visibility
+- Optionally selecting specific tags to upload only tasks with certain tags
+
+#### Examples and Resources
+
+- Example Dataset: [ddupont/test-dataset](https://huggingface.co/datasets/ddupont/test-dataset)
+- Find Community Datasets: 🔍 [Browse CUA Datasets on Huggingface](https://huggingface.co/datasets?other=cua)
+

{cua_computer-0.1.23.dist-info → cua_computer-0.1.24.dist-info}/RECORD

@@ -5,7 +5,7 @@ computer/interface/base.py,sha256=MypCT28XGSITKcdMEpmxkIuE0IKeGLtl5c4v9btzc88,53
 computer/interface/factory.py,sha256=7Sczbmgu7Zlf9QfmhxOe_wFawRSPpvwd2dLSA4asDs0,1028
 computer/interface/linux.py,sha256=0Kc_vkPnEUlKUcVYMycbxiuKyZOpOPwwmUcFJbFmopE,817
 computer/interface/macos.py,sha256=08BTROfTTvYq7YjEzy1j3Jk_eJB_nYxtkbdPc8NySOQ,24545
-computer/interface/models.py,sha256=K9bSl6Ne_hStLq653gHgFLYB4_vuewtm2aVFojvnOwY,2570
+computer/interface/models.py,sha256=RZKVUdwKrKUoFqwlx2Dk8Egkmq_AInlIu_d0xg7SZzw,3238
 computer/logger.py,sha256=UVvnmZGOWVF9TCsixEbeQnDZ3wBPAJ2anW3Zp-MoJ8Y,2896
 computer/models.py,sha256=6chs4wxMpWdVhsOETeaGqFFI3feBmSyLIC8l5EJDq5g,780
 computer/telemetry.py,sha256=FvNFpxgeRuCMdNpREuSL7bOMZy9gSzY4J0rLeNDw0CU,3746
@@ -13,7 +13,7 @@ computer/ui/__init__.py,sha256=pmo05ek9qiB_x7DPeE6Vf_8RsIOqTD0w1dBLMHfoOnY,45
 computer/ui/gradio/__init__.py,sha256=5_KimixM48-X74FCsLw7LbSt39MQfUMEL8-M9amK3Cw,117
 computer/ui/gradio/app.py,sha256=HKlVx9dvjcXkrUDq3EmRsfBOhZLBPzSxlYsaEN8Et_E,64081
 computer/utils.py,sha256=zY50NXB7r51GNLQ6l7lhG_qv0_ufpQ8n0-SDhCei8m4,2838
-cua_computer-0.1.23.dist-info/METADATA,sha256=6jZPeNpEXOuJ-iFUeMlXOvjnp2qe3umM7WYWLYXb5ok,3995
-cua_computer-0.1.23.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
-cua_computer-0.1.23.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-cua_computer-0.1.23.dist-info/RECORD,,
+cua_computer-0.1.24.dist-info/METADATA,sha256=ciHf85TAHOn6Ecuuztb5p7h96s-xVj_y-0NtF0W6wgU,5579
+cua_computer-0.1.24.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+cua_computer-0.1.24.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+cua_computer-0.1.24.dist-info/RECORD,,