mirror of
https://github.com/FoundationAgents/MetaGPT.git
synced 2026-05-18 13:55:17 +02:00
refine README.md
This commit is contained in:
geekan
parent
f438631609
commit
6b068f38da
2 changed files with 20 additions and 100 deletions
64
README.md
64
README.md
|
|
@ -4,23 +4,9 @@ # MetaGPT: The Multi-Role Meta Programming Framework
|
|||
|
||||
## Objective
|
||||
|
||||
1. Our ultimate goal is to enable GPT to train, fine-tune, and ultimately, utilize itself, aiming to achieve a level of **self-evolution.**
|
||||
1. Once GPT can optimize itself, it will have the capacity to continually improve its own performance without the constant need for manual tuning. This kind of self-evolution enables an **autonomous cycle of growth** where the AI can identify areas for its own improvement, make necessary adjustments, and implement those changes to better achieve its objectives. **It could potentially lead to an exponential growth in the system's capabilities.**
|
||||
2. Currently, we have managed to enable GPT to work in teams, collaborating to tackle more complex tasks.
|
||||
1. For instance, `startup.py` consists of **product manager / architect / project manager / engineer**, it provides the full process of a **software company.**
|
||||
2. The team can cooperate and generate **user stories / competetive analysis / requirements / data structures / apis / files etc.**
|
||||
|
||||
### Philosophy
|
||||
|
||||
The core assets of a software company are three: Executable Code, SOP (Standard Operating Procedures), and Team.
|
||||
There is a formula:
|
||||
|
||||
```
|
||||
Executable Code = SOP(Team)
|
||||
```
|
||||
|
||||
We have practiced this process and expressed the SOP in the form of code,
|
||||
and the team itself only used large language models.
|
||||
1. Currently, we have managed to enable GPT to work in teams, collaborating to tackle more complex tasks.
|
||||
1. The team can handle **Boss's one line Requirement** cooperate and generate **user stories / competetive analysis / requirements / data structures / apis / files etc.**
|
||||
2. The team consists of **product manager / architect / project manager / engineer**, it provides the full process of a **software company.**
|
||||
|
||||
## Examples (fully generated by GPT-4)
|
||||
|
||||
|
|
@ -29,11 +15,11 @@ ## Examples (fully generated by GPT-4)
|
|||
1. It requires around **$0.2** (GPT-4 api's costs) to generate one example with analysis and design.
|
||||
2. It requires around **$2.0** (GPT-4 api's costs) to generate one example with a full project.
|
||||
|
||||
| | Design an MLOps/LLMOps framework that supports GPT-4 and other LLMs | Design a game like Candy Crush Saga | Design a RecSys like Toutiao | Design a roguelike game like NetHack | Design a search algorithm framework | Design a minimal pomodoro timer |
|
||||
|----------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Competitive Analysis |  |  |  |  |  |  |
|
||||
| Data & API Design |  |  |  |  |  |  |
|
||||
| Sequence Flow |  |  |  |  |  |  |
|
||||
| | Design an MLOps/LLMOps framework that supports GPT-4 and other LLMs | Design a RecSys like Toutiao | Design a search algorithm framework |
|
||||
|----------------------|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Competitive Analysis |  |  |  |
|
||||
| Data & API Design |  |  |  |
|
||||
| Sequence Flow |  |  |  |
|
||||
|
||||
|
||||
## Installation
|
||||
|
|
@ -53,7 +39,7 @@ # Step 3: Clone the repository to your local machine, and install it.
|
|||
|
||||
## Configuration
|
||||
|
||||
- You can configure your `OPENAI_API_KEY` in `config/key.yaml / config/config.yaml / env`
|
||||
- Configure your `OPENAI_API_KEY` in `config/key.yaml / config/config.yaml / env`
|
||||
- Priority order: `config/key.yaml > config/config.yaml > env`
|
||||
|
||||
```bash
|
||||
|
|
@ -94,31 +80,7 @@ ### Code walkthrough
|
|||
await company.run(n_round=n_round)
|
||||
```
|
||||
|
||||
## Tutorial: single role and LLM examples
|
||||
|
||||
### The framework support single role as well, here's a simple sales role use case
|
||||
|
||||
```python
|
||||
from metagpt.const import DATA_PATH
|
||||
from metagpt.document_store import FaissStore
|
||||
from metagpt.roles import Sales
|
||||
|
||||
store = FaissStore(DATA_PATH / 'example.pdf')
|
||||
role = Sales(profile='Sales', store=store)
|
||||
result = await role.run('Which facial cleanser is good for oily skin?')
|
||||
```
|
||||
|
||||
### The framework also provide llm interfaces
|
||||
|
||||
```python
|
||||
from metagpt.llm import LLM
|
||||
|
||||
llm = LLM()
|
||||
await llm.aask('hello world')
|
||||
|
||||
hello_msg = [{'role': 'user', 'content': 'hello'}]
|
||||
await llm.acompletion(hello_msg)
|
||||
```
|
||||
You can check `examples` for more details on single role (with knowledge base) and LLM only examples.
|
||||
|
||||
## Contact Information
|
||||
|
||||
|
|
@ -129,12 +91,6 @@ ## Contact Information
|
|||
|
||||
We aim to respond to all inquiries within 2-3 business days.
|
||||
|
||||
|
||||
## Demo
|
||||
|
||||
| blackjack | adventure-game | 2048 | pomodoro-timer |
|
||||
|-----------|-----------|-----------|-----------|
|
||||
|  |  |  |  |
|
||||
|
||||
|
||||
https://github.com/geekan/MetaGPT/assets/2707039/5e8c1062-8c35-440f-bb20-2b0320f8d27d
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue