Skip to content

Commit 86b9096

Browse files
authored
Merge pull request #397 from trycua/feat/link-docs-examples
Add references to standalone examples and notebooks
2 parents a6165a5 + 8015354 commit 86b9096

File tree

6 files changed

+12
-0
lines changed

6 files changed

+12
-0
lines changed

docs/content/docs/agent-sdk/agent-loops.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Agent Loops
33
description: Supported computer-using agent loops and models
44
---
55

6+
<Callout>A corresponding <a href="https://github.com/trycua/cua/blob/main/notebooks/agent_nb.ipynb" target="_blank">Jupyter Notebook</a> is available for this documentation.</Callout>
7+
68
An agent can be thought of as a loop - it generates actions, executes them, and repeats until done:
79

810
1. **Generate**: Your `model` generates `output_text`, `computer_call`, `function_call`

docs/content/docs/agent-sdk/integrations/hud.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: HUD Evals
33
description: Use ComputerAgent with HUD for benchmarking and evaluation
44
---
55

6+
<Callout>A corresponding <a href="https://github.com/trycua/cua/blob/main/notebooks/eval_osworld.ipynb" target="_blank">Jupyter Notebook</a> is available for this documentation.</Callout>
7+
68
The HUD integration allows an agent to be benchmarked using the [HUD framework](https://www.hud.so/). Through the HUD integration, the agent controls a computer inside HUD, where tests are run to evaluate the success of each task.
79

810
## Installation

docs/content/docs/computer-sdk/computers.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Cua Computers
33
description: Understanding cua computer types and connection methods
44
---
55

6+
<Callout>A corresponding <a href="https://github.com/trycua/cua/blob/main/notebooks/computer_nb.ipynb" target="_blank">Jupyter Notebook</a> and <a href="https://github.com/trycua/cua/tree/main/examples/computer-example-ts" target="_blank">NodeJS project</a> are available for this documentation.</Callout>
7+
68
Before we can automate apps using AI, we need to first connect to a Computer Server to give the AI a safe environment to execute workflows in.
79

810
Cua Computers are preconfigured virtual machines running the Computer Server. They can be either macOS, Linux, or Windows. They're found in either a cloud-native container, or on your host desktop.

docs/content/docs/computer-sdk/sandboxed-python.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Sandboxed Python
33
slug: sandboxed-python
44
---
55

6+
<Callout>A corresponding <a href="https://github.com/trycua/cua/blob/main/examples/sandboxed_functions_examples.py" target="_blank">Python example</a> is available for this documentation.</Callout>
7+
68
You can run Python functions securely inside a sandboxed virtual environment on a remote Cua Computer. This is useful for executing untrusted user code, isolating dependencies, or providing a safe environment for automation tasks.
79

810
## How It Works

docs/content/docs/libraries/computer-server/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ github:
66
- https://github.com/trycua/cua/tree/main/libs/python/computer-server
77
---
88

9+
<Callout>A corresponding <a href="https://github.com/trycua/cua/blob/main/notebooks/computer_server_nb.ipynb" target="_blank">Jupyter Notebook</a> is available for this documentation.</Callout>
10+
911
The Computer Server API reference documentation is currently under development.
1012

1113
## Overview

docs/content/docs/libraries/som/index.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ github:
66
- https://github.com/trycua/cua/tree/main/libs/python/som
77
---
88

9+
<Callout>A corresponding <a href="https://github.com/trycua/cua/blob/main/examples/som_examples.py" target="_blank">Python example</a> is available for this documentation.</Callout>
10+
911
## Overview
1012

1113
The SOM library provides visual element detection and interaction capabilities. It is based on the [Set-of-Mark](https://arxiv.org/abs/2310.11441) research paper and the [OmniParser](https://github.com/microsoft/OmniParser) model.

0 commit comments

Comments
 (0)