Skip to content

Commit

Permalink
feat: docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ASL-r committed Jul 11, 2024
1 parent b955088 commit d3145f5
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/source/case/gaia.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ With everything in place, it's time to start the GAIA benchmark.
python scripts/gaia/test_gaia.py --level <level_in_gaia> --max_workers <thread_number>
- Replace `<level_in_gaia>` with your chosen difficulty (1, 2, or 3).
- Set `<thread_number>` to decide how many tasks the team handles simultaneously.
- Replace :code:`<level_in_gaia>` with your chosen difficulty (1, 2, or 3).
- Set :code:`<thread_number>` to decide how many tasks the team handles simultaneously.
2 changes: 1 addition & 1 deletion docs/source/customize/goal_submission.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The full URL :code:`url: "http://127.0.0.1:5050/launch_goal"` is used to send a
import requests
goal = "task descrpition"
"(e.g. goal = I want to know the annual revenue of Microsoft from 2014 to 2020. Please generate a figure in text format showing the trend of the annual revenue, and give me a analysis report.)"
# e.g. goal = I want to know the annual revenue of Microsoft from 2014 to 2020. Please generate a figure in text format showing the trend of the annual revenue, and give me a analysis report.
response = requests.post(
"http://127.0.0.1:5050/launch_goal",
json={
Expand Down
2 changes: 1 addition & 1 deletion docs/source/customize/integrate_thirdparty_agent.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Open Interpreter Docker Startup
docker build -f dockerfiles/tool_agents/open_interpreter.Dockerfile -t open_interpreter:latest .
* Then, start the server and multiple communication agents by running:
* Then, start the server and communication agents by running:

.. code-block:: bash
Expand Down
12 changes: 6 additions & 6 deletions docs/source/customize/tool_creation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,16 @@ Tool with required parameters
.. code-block:: yaml
- function:
description: your function description
description: function description
name: function name
parameters:
properties:
parameters_1:
description: your parameters_1 description
description: parameters_1 description
type: string / number / boolean
enum: ["It's necessary if your parameter is set by Literal type OR specified parameter"]
parameters_2: # It's necessary if there are more than 1 parameter in your function
description: your parameters_2 description
enum: ["It's necessary if parameter is set by Literal type OR specified parameter"]
parameters_2: # It's necessary if there are more than 1 parameter in function
description: parameters_2 description
type: string / number / boolean
required:
- parameters_1
Expand All @@ -48,7 +48,7 @@ Tool without required parameters
.. code-block:: yaml
- function:
description: your function description
description: function description
name: function name
parameters:
properties: {}
Expand Down
10 changes: 5 additions & 5 deletions docs/source/distributed_service/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ This guide explains how to configure and run the IoA framework across multiple d
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Open two ports on your server:

- <SERVER_PORT> (default: 7788) for the IoA server
- <FRONTEND_PORT> (default: 80) for the web frontend
- :code:`<SERVER_PORT>` (default: 7788) for the IoA server
- :code:`<FRONTEND_PORT>` (default: 80) for the web frontend

.. note:: If the default ports are occupied, choose alternative available ports.

Expand Down Expand Up @@ -141,7 +141,7 @@ Launch the IoA server:
docker-compose -f dockerfiles/compose/server_only.yaml up
.. note:: If using custom ports, modify the `server_only.yaml` file:
.. note:: If using custom ports, modify the :code:`server_only.yaml` file:

.. code-block:: yaml
Expand All @@ -155,7 +155,7 @@ Launch the IoA server:
4. Access the Frontend
^^^^^^^^^^^^^^^^^^^^^^
Open `http://<SERVER_IP>:<FRONTEND_PORT>` in a web browser to view the agents' communication interface.
Open :code:`http://<SERVER_IP>:<FRONTEND_PORT>` in a web browser to view the agents' communication interface.

💻 Client Setup
---------------
Expand Down Expand Up @@ -199,7 +199,7 @@ Start your client with the configured agent. For example:
docker-compose -f dockerfiles/compose/example.yaml up
.. note:: Ensure you've updated `configs/client_configs/case/example/bob.yaml` with the correct <SERVER_PORT> and <SERVER_IP>.
.. note:: Ensure you've updated :code:`configs/client_configs/case/example/bob.yaml` with the correct :code:`<SERVER_PORT>` and :code:`<SERVER_IP>`.

❓ Troubleshooting
-------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/high_level_concepts/mechanism.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This mechanism allows agents to join the IoA ecosystem and find suitable collabo

* **Agent Registration**: When a new agent joins IoA, it registers with the server by providing a comprehensive description of its capabilities, skills, and expertise. This information is stored in the Agent Registry Block of the server's Data Layer.

* **Agent Discovery**: Agents can search for collaborators using the `search_client` tool provided by the server's Agent Query Block. This tool leverages the information in the Agent Registry to match agents based on desired characteristics or capabilities.
* **Agent Discovery**: Agents can search for collaborators using the :code:`search_client` tool provided by the server's Agent Query Block. This tool leverages the information in the Agent Registry to match agents based on desired characteristics or capabilities.

🤝 Autonomous Nested Team Formation
-----------------------------------
Expand All @@ -18,7 +18,7 @@ This mechanism enables dynamic and flexible team creation, allowing agents to fo
.. figure:: ../_static/nested-team-up.png
:class: custom-img

* **Team Formation Process**: When assigned a task, an agent initiates team formation using the `search_client` and `launch_group_chat` tools. It can recursively form sub-teams as needed for multi-faceted tasks.
* **Team Formation Process**: When assigned a task, an agent initiates team formation using the :code:`search_client` and :code:`launch_group_chat` tools. It can recursively form sub-teams as needed for multi-faceted tasks.

* **Nested Team Structure**: This hierarchical approach reduces communication complexity and enhances collaboration efficiency, especially for complex tasks requiring diverse skills.

Expand Down

0 comments on commit d3145f5

Please sign in to comment.