Skip to content

Commit

Permalink
removed source code from documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
om-raheja committed Aug 22, 2024
1 parent 4dd9374 commit e2b9f4a
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 4 deletions.
14 changes: 12 additions & 2 deletions docs/source/agent_developer/agent_database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,15 @@ And conversely, upload with a similar command as well:
Please note that updating an agent after uploading is not available at this time. When the Agent Hub is finalized, it will be.

.. literalinclude:: ../../../pyopenagi/agents/interact.py
:language: python
The help message for ``interact.py`` is as follows:

.. code-block:: bash
$ python3 interact.py -h
usage: interact.py [-h] [--mode {download,upload}] --agent AGENT
options:
-h, --help show this help message and exit
--mode {download,upload}
--agent AGENT
7 changes: 6 additions & 1 deletion docs/source/agent_developer/agents/agent_index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,12 @@ Here is the outline for each file

agent.py
config.json
meta_requirements.txt

``meta_requirements.txt`` is used to install dependencies for your agent. For example, if you want to use the transformers library, you can add ``transformers`` to ``meta_requirements.txt``. All of the dependencies can be installed with:

.. code-block:: bash
pip install -r meta_requirements.txt
Here we provide some useful agent templates to use the agent.

Expand Down
15 changes: 15 additions & 0 deletions docs/source/agent_developer/agents/config.json.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _config.json.rst:

Agent metadata
===================

You are going to include a JSON file with the following attributes:

1. ``name``: Name, spaces separated with _
2. ``description``: An array with one string that contains a description
3. ``tools``: A list of tools used
4. ``meta``: A dictionary with the following keys: ``author``, ``version``, ``license``

For example, here is the config.json for Transcriber Agent:

.. literalinclude:: ../../../../pyopenagi/agents/example/transcribe_agent/config.json
2 changes: 1 addition & 1 deletion pyopenagi/agents/example/transcribe_agent/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
"version": "0.0.1",
"license": "CC0"
}
}
}

0 comments on commit e2b9f4a

Please sign in to comment.