advantage usage doc

microsoft · Jul 3, 2024 · 2bb0699 · 2bb0699
1 parent 4d165f0
commit 2bb0699
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 3 deletions.
diff --git a/documents/docs/agents/evaluation_agent.md b/documents/docs/agents/evaluation_agent.md
@@ -5,6 +5,16 @@ The objective of the `EvaluationAgent` is to evaluate whether a `Session` or `Ro
     The `EvaluationAgent` is fully LLM-driven and conducts evaluations based on the action trajectories and screenshots. It may not by 100% accurate since LLM may make mistakes.
 
 
+## Configuration
+To enable the `EvaluationAgent`, you can configure the following parameters in the `config_dev.yaml` file to evaluate the task completion status at different levels:
+
+| Configuration Option      | Description                                   | Type    | Default Value |
+|---------------------------|-----------------------------------------------|---------|---------------|
+| `EVA_SESSION`             | Whether to include the session in the evaluation. | Boolean | True          |
+| `EVA_ROUND`               | Whether to include the round in the evaluation.   | Boolean | False         |
+| `EVA_ALL_SCREENSHOTS`     | Whether to include all the screenshots in the evaluation. | Boolean | True          |
+
+
 ## Evaluation Inputs
 The `EvaluationAgent` takes the following inputs for evaluation:
 
@@ -18,7 +28,7 @@ The `EvaluationAgent` takes the following inputs for evaluation:
 For more details on how to construct the inputs, please refer to the `EvaluationAgentPrompter` class in `ufo/prompter/eva_prompter.py`.
 
 !!! tip
-    You can configure whether to use all screenshots or only the first and last screenshot for evaluation in the `config_dev.yaml` file.
+    You can configure whether to use all screenshots or only the first and last screenshot for evaluation in the `EVA_ALL_SCREENSHOTS` of the `config_dev.yaml` file.
 
 
 ## Evaluation Outputs

diff --git a/documents/docs/creating_app_agent/overview.md b/documents/docs/creating_app_agent/overview.md
@@ -0,0 +1,11 @@
+# Creating Your AppAgent
+
+UFO provides a flexible framework and SDK for application developers to empower their applications with AI capabilities by wrapping them into an `AppAgent`. By creating an `AppAgent`, you can leverage the power of UFO to interact with your application and automate tasks.
+
+To create an `AppAgent`, you can provide the following components:
+
+| Component | Description | Usage Documentation |
+| --- | --- | --- |
+| [Help Documents](./help_document_provision.md) | The help documents for the application to guide the `AppAgent` in executing tasks. | [Learning from Help Documents](../advanced_usage/reinforce_appagent/learning_from_help_document.md) |
+| [User Demonstrations](./demonstration_provision.md) | The user demonstrations for the application to guide the `AppAgent` in executing tasks. | [Learning from User Demonstrations](../advanced_usage/reinforce_appagent/learning_from_demonstration.md) |
+| [Native API Wrappers](./warpping_app_native_api.md) | The native API wrappers for the application to interact with the application. | [Automator](../automator/overview.md) |
diff --git a/documents/docs/faq.md b/documents/docs/faq.md
@@ -24,8 +24,8 @@ A: Yes, you can host your custom LLM endpoint and configure UFO to use it. Check
 ## Q7: Can I use non-English requests in UFO?
 A: It depends on the language model you are using. Most of LLMs support multiple languages, and you can specify the language in the request. However, the performance may vary for different languages.
 
-## Q8: It shows the error `Error making API request: ('Connection aborted.', RemoteDisconnected('Remote end closed connection without response'))` when I run UFO. What should I do?
+## Q8: Why it shows the error `Error making API request: ('Connection aborted.', RemoteDisconnected('Remote end closed connection without response'))`?
 A: This means the LLM endpoint is not accessible. You can check the network connection (e.g. VPN) and the status of the LLM endpoint. 
 
-!!! tip
+!!! info
     To get more support, please submit an issue on the [GitHub Issues](https://github.com/microsoft/UFO/issues), or send an email to [ufo-agent@microsoft.com](mailto:ufo-agent@microsoft.com).
diff --git a/documents/mkdocs.yml b/documents/mkdocs.yml
@@ -68,6 +68,7 @@ nav:
         - Icon Filtering: advanced_usage/control_filtering/icon_filtering.md
       - Customization: advanced_usage/customization.md
   - Creating Your AppAgent: 
+      - Overview: creating_app_agent/overview.md
       - Help Document Provision: creating_app_agent/help_document_provision.md
       - Demonstration Provision: creating_app_agent/demonstration_provision.md
       - Warpping App-Native API: creating_app_agent/warpping_app_native_api.md