added model compat

This commit is contained in:
Dillon DuPont
2025-06-19 19:09:01 -04:00
parent 22a56c4491
commit 0f64e2eeef
2 changed files with 27 additions and 47 deletions

View File

@@ -6,7 +6,7 @@
- [Ubuntu/Linux Host](#ubuntulinux-host)
- [Windows Host](#windows-host)
- [VM Emulation Support](#vm-emulation-support)
- [Installation Method Details](#installation-method-details)
- [Model Provider Compatibility](#model-provider-compatibility)
---
@@ -71,49 +71,16 @@
| **Cloud** | 🚧 Coming soon | ✅ Full support | 🚧 Coming soon | Currently Ubuntu only, macOS/Windows in development |
| **Winsandbox** | ❌ Not supported | ❌ Not supported | ✅ Windows only | Windows Sandbox environments only |
### VM Emulation Details
#### Lume VM Support
- **macOS VMs**: ✅ Full native support with official images
- **Ubuntu/Linux VMs**: ⚠️ Limited support - requires custom image creation
- **Windows VMs**: ⚠️ Limited support - requires custom image creation
#### Cloud VM Support
- **Ubuntu/Linux VMs**: ✅ Full support with managed cloud instances
- **macOS VMs**: 🚧 Coming soon - in development
- **Windows VMs**: 🚧 Coming soon - in development
#### Windows Sandbox VM Support
- **Windows VMs**: ✅ Full support for Windows Sandbox environments
- **macOS/Linux VMs**: ❌ Not supported - Windows Sandbox only runs Windows
---
## Installation Method Details
## Model Provider Compatibility
### playground-docker.sh
- **Containerized setup** using Docker
- Handles all dependencies automatically
- Requires Docker Desktop (Windows/macOS) or Docker Engine (Linux)
- **Windows note**: Must run in WSL2 environment
*This section shows which **AI model providers** are supported on each host operating system.*
### Dev Container
- **Development-focused** setup for contributors
- Integrates with VS Code and WindSurf IDEs
- Provides consistent development environment
- **Windows note**: Requires WSL2 backend for Docker
### PyPI packages
- **Manual installation** via pip
- Most flexible installation method
- Allows custom configurations and integrations
- **Windows note**: Shell scripts require WSL2, but Python packages work natively
---
## Legend
-**Full support**: All features work natively without limitations
- ⚠️ **Partial support**: Requires additional setup (e.g., WSL2) or has limitations
-**Not supported**: Feature/provider combination is not available
- 🚧 **Coming soon**: Feature/provider combination is in development
| Provider | macOS Host | Ubuntu/Linux Host | Windows Host | Notes |
|----------|------------|-------------------|--------------|-------|
| **Anthropic** | ✅ Full support | ✅ Full support | ✅ Full support | Cloud-based API |
| **OpenAI** | ✅ Full support | ✅ Full support | ✅ Full support | Cloud-based API |
| **Ollama** | ✅ Full support | ✅ Full support | ✅ Full support | Local model serving |
| **OpenAI Compatible** | ✅ Full support | ✅ Full support | ✅ Full support | Any OpenAI-compatible API endpoint |
| **MLX VLM** | ✅ macOS only | ❌ Not supported | ❌ Not supported | Apple Silicon required. PyPI installation only. |

View File

@@ -81,6 +81,19 @@ This repository includes a [Dev Container](./.devcontainer/README.md) configurat
---
### Option 3: PyPI
*Direct Python package installation*
```bash
# conda create -yn cua python==3.12
pip install -U "cua-computer[all]" "cua-agent[all]"
python -m agent.ui # Start the agent UI
```
Or check out the [Usage Guide](#-usage-guide) to learn how to use our Python SDK in your own code.
---
## Supported [Agent Loops](https://github.com/trycua/cua/blob/main/libs/agent/README.md#agent-loops)
- [UITARS-1.5](https://github.com/trycua/cua/blob/main/libs/agent/README.md#agent-loops) - Run locally on Apple Silicon with MLX, or use cloud providers
@@ -88,16 +101,16 @@ This repository includes a [Dev Container](./.devcontainer/README.md) configurat
- [Anthropic CUA](https://github.com/trycua/cua/blob/main/libs/agent/README.md#agent-loops) - Use Anthropic's Computer-Use capabilities
- [OmniParser-v2.0](https://github.com/trycua/cua/blob/main/libs/agent/README.md#agent-loops) - Control UI with [Set-of-Marks prompting](https://som-gpt4v.github.io/) using any vision model
## 🖥️ OS Compatibility
## 🖥️ Compatibility
For detailed compatibility information including host OS support and VM emulation capabilities, see the [**Compatibility Matrix**](./COMPATIBILITY.md).
For detailed compatibility information including host OS support, VM emulation capabilities, and model provider compatibility, see the [Compatibility Matrix](./COMPATIBILITY.md).
<br/>
<br/>
# 💻 Developer Guide
# 🐍 Usage Guide
Follow these steps to use C/ua in your own code. See [Developer Guide](./docs/Developer-Guide.md) for building from source.
Follow these steps to use C/ua in your own Python code. See [Developer Guide](./docs/Developer-Guide.md) for building from source.
### Step 1: Install Lume CLI