Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
vyokky committed Jun 28, 2024
1 parent 6052a81 commit 2666ad8
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -14,15 +14,15 @@

</div>

**UFO** is a **UI-Focused** dual-agent framework to fulfill user requests on **Windows OS** by seamlessly navigating and operating within individual or spanning multiple applications.
**UFO** is a **UI-Focused** multi-agent framework to fulfill user requests on **Windows OS** by seamlessly navigating and operating within individual or spanning multiple applications.

<h1 align="center">
<img src="./assets/overview_n.png"/>
</h1>


## 🕌 Framework
<b>UFO</b> <img src="./assets/ufo_blue.png" alt="UFO Image" width="24"> operates as a dual-agent framework, encompassing:
<b>UFO</b> <img src="./assets/ufo_blue.png" alt="UFO Image" width="24"> operates as a multi-agent framework, encompassing:
- <b>HostAgent (Previously AppAgent) 🤖</b>, tasked with choosing an application for fulfilling user requests. This agent may also switch to a different application when a request spans multiple applications, and the task is partially completed in the preceding application.
- <b>AppAgent (Previously ActAgent) 👾</b>, responsible for iteratively executing actions on the selected applications until the task is successfully concluded within a specific application.
- <b>Control Interaction 🎮</b>, is tasked with translating actions from HostAgent and AppAgent into interactions with the application and its UI controls. It's essential that the targeted controls are compatible with the Windows **UI Automation** or **Win32** API.
4 changes: 2 additions & 2 deletions documents/docs/index.md
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@

## Introduction

**UFO** is a **UI-Focused** dual-agent framework to fulfill user requests on **Windows OS** by seamlessly navigating and operating within individual or spanning multiple applications.
**UFO** is a **UI-Focused** multi-agent framework to fulfill user requests on **Windows OS** by seamlessly navigating and operating within individual or spanning multiple applications.

<h1 align="center">
<img src="./img/overview_n.png"/>
@@ -18,7 +18,7 @@


## 🕌 Framework
<b>UFO</b> <img src="./img/ufo_blue.png" alt="UFO Image" width="24"> operates as a dual-agent framework, encompassing:
<b>UFO</b> <img src="./img/ufo_blue.png" alt="UFO Image" width="24"> operates as a multi-agent framework, encompassing:

- <b>HostAgent 🤖</b>, tasked with choosing an application for fulfilling user requests. This agent may also switch to a different application when a request spans multiple applications, and the task is partially completed in the preceding application.

4 changes: 2 additions & 2 deletions documents/docs/supported_models/custom_model.md
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ def chat_completion(
pass
```

### Step 3
## Step 3
After implementing the LLM model class, you can configure the `HOST_AGENT` and `APP_AGENT` in the `config.yaml` file (rename the `config_template.yaml` file to `config.yaml`) to use the custom LLM model. The following is an example configuration for the custom LLM model:

```yaml
@@ -45,5 +45,5 @@ After implementing the LLM model class, you can configure the `HOST_AGENT` and `
API_MODEL: "YOUR_MODEL", # The custom LLM model name.
```
### Step 4
## Step 4
After configuring the `HOST_AGENT` and `APP_AGENT` with the custom LLM model, you can start using UFO to interact with the custom LLM model for various tasks on Windows OS. Please refer to the [Quick Start Guide](../getting_started/quick_start.md) for more details on how to get started with UFO.

0 comments on commit 2666ad8

Please sign in to comment.