Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
HenryQW committed Jul 22, 2024
1 parent b7651ce commit 64614ca
Showing 1 changed file with 1 addition and 55 deletions.
56 changes: 1 addition & 55 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,58 +13,4 @@

OpenAgent is a framework for building AI applications leveraging the power of blockchains and RSS3 Network.

The framework consists of 3 main components that are deployed together to form a complete application.

## Backend: LLM, Experts

A set of APIs for responding to requests from the frontend. It leverages LangChain to offer interoperability between different LLMs.

It leverages the power of RSS3 Network to retrieve knowledge and feed into designated Experts.

### LLM Compatibility

Theoretically, OpenAgent is compatible with any LLMs with function calling capability.
We encourage you to test with your chosen LLMs and contribute to the compatibility lists below.
Here we provide a list of LLMs tested to be sufficiently intelligent for the purpose:

#### Open Source LLMs

| Open Source LLMs | Performance |
|---------------------|-------------|
| llama3 | ★★★★☆ |
| codellama | ★★★☆☆ |
| gemma | ★★★☆☆ |
| aya | ★★☆☆☆ |
| mistral | ★★☆☆☆ |
| deepseek-coder | ★☆☆☆☆ |
| solar | ★☆☆☆☆ |
| llava | ★☆☆☆☆ |
| phi3 | ★☆☆☆☆ |


#### Proprietary LLMs

| Proprietary LLMs | Performance |
|---------------------|-------------|
| gpt-3.5-turbo | ★★★★★ |
| gpt-4-turbo | ★★★★★ |
| gpt-4o | ★★★★★ |
| gemini-1.5-flash | ★★★★☆ |
| gemini-1.5-pro | ★★★★☆ |


See [backend/README.md](backend/README.md) for more information on development and deployment.

## Frontend: Client

A sample web application that serves and a Client to enable user interactions with the backend.

See [frontend/README.md](frontend/README.md) for more information on development and deployment.

## Executor

A set of APIs for executing and submitting transactions on chain. It should be gated under all circumstances to prevent unauthorized access.

In addition, the repository also contains a set of sample smart contracts that need to be deployed before you can use the Executor. See [executor/contracts/README.md](executor/contracts/README.md) for more information.

See [executor/README.md](executor/README.md) for more information on development and deployment.
For more information, please visit the [OpenAgent docs](https://docs.rss3.io/guide/artificial-intelligence/openagent).

0 comments on commit 64614ca

Please sign in to comment.