新修改。

This commit is contained in:
zhouzinimg 2023-10-18 19:40:41 +08:00
parent f3c7da32a0
commit 9af9461b4f
152 changed files with 7692 additions and 792 deletions

129
README.md
View file

@ -25,9 +25,11 @@ # MetaGPT: The Multi-Agent Framework
<a href="https://huggingface.co/spaces/deepwisdom/MetaGPT" target="_blank"><img alt="Hugging Face" src="https://img.shields.io/badge/%F0%9F%A4%97%20-Hugging%20Face-blue?color=blue&logoColor=white" /></a>
</p>
1. MetaGPT takes a **one line requirement** as input and outputs **user stories / competitive analysis / requirements / data structures / APIs / documents, etc.**
2. Internally, MetaGPT includes **product managers / architects / project managers / engineers.** It provides the entire process of a **software company along with carefully orchestrated SOPs.**
1. `Code = SOP(Team)` is the core philosophy. We materialize SOP and apply it to teams composed of LLMs.
1. MetaGPT takes a **one line requirement** as input and outputs **user stories / competitive analysis / requirements /
data structures / APIs / documents, etc.**
2. Internally, MetaGPT includes **product managers / architects / project managers / engineers.** It provides the entire
process of a **software company along with carefully orchestrated SOPs.**
1. `Code = SOP(Team)` is the core philosophy. We materialize SOP and apply it to teams composed of LLMs.
![A software company consists of LLM-based roles](docs/resources/software_company_cd.jpeg)
@ -35,21 +37,17 @@ # MetaGPT: The Multi-Agent Framework
## MetaGPT's Abilities
https://github.com/geekan/MetaGPT/assets/34952977/34345016-5d13-489d-b9f9-b82ace413419
## Examples (fully generated by GPT-4)
For example, if you type `python startup.py "Design a RecSys like Toutiao"`, you would get many outputs, one of them is data & api design
For example, if you type `python startup.py "Design a RecSys like Toutiao"`, you would get many outputs, one of them is
data & api design
![Jinri Toutiao Recsys Data & API Design](docs/resources/workspace/content_rec_sys/resources/data_api_design.png)
It costs approximately **$0.2** (in GPT-4 API fees) to generate one example with analysis and design, and around **$2.0** for a full project.
It costs approximately **$0.2** (in GPT-4 API fees) to generate one example with analysis and design, and around **$2.0
** for a full project.
## Installation
@ -75,10 +73,12 @@ # Step 3: Clone the repository to your local machine, and install it.
**Note:**
- If already have Chrome, Chromium, or MS Edge installed, you can skip downloading Chromium by setting the environment variable
- If already have Chrome, Chromium, or MS Edge installed, you can skip downloading Chromium by setting the environment
variable
`PUPPETEER_SKIP_CHROMIUM_DOWNLOAD` to `true`.
- Some people are [having issues](https://github.com/mermaidjs/mermaid.cli/issues/15) installing this tool globally. Installing it locally is an alternative solution,
- Some people are [having issues](https://github.com/mermaidjs/mermaid.cli/issues/15) installing this tool globally.
Installing it locally is an alternative solution,
```bash
npm install @mermaid-js/mermaid-cli
@ -91,72 +91,75 @@ # Step 3: Clone the repository to your local machine, and install it.
MMDC: "./node_modules/.bin/mmdc"
```
- if `pip install -e.` fails with error `[Errno 13] Permission denied: '/usr/local/lib/python3.11/dist-packages/test-easy-install-13129.write-test'`, try instead running `pip install -e. --user`
- if `pip install -e.` fails with
error `[Errno 13] Permission denied: '/usr/local/lib/python3.11/dist-packages/test-easy-install-13129.write-test'`,
try instead running `pip install -e. --user`
- To convert Mermaid charts to SVG, PNG, and PDF formats. In addition to the Node.js version of Mermaid-CLI, you now have the option to use Python version Playwright, pyppeteer or mermaid.ink for this task.
- To convert Mermaid charts to SVG, PNG, and PDF formats. In addition to the Node.js version of Mermaid-CLI, you now
have the option to use Python version Playwright, pyppeteer or mermaid.ink for this task.
- Playwright
- **Install Playwright**
- Playwright
- **Install Playwright**
```bash
pip install playwright
```
```bash
pip install playwright
```
- **Install the Required Browsers**
- **Install the Required Browsers**
to support PDF conversion, please install Chrominum.
to support PDF conversion, please install Chrominum.
```bash
playwright install --with-deps chromium
```
```bash
playwright install --with-deps chromium
```
- **modify `config.yaml`**
- **modify `config.yaml`**
uncomment MERMAID_ENGINE from config.yaml and change it to `playwright`
uncomment MERMAID_ENGINE from config.yaml and change it to `playwright`
```yaml
MERMAID_ENGINE: playwright
```
```yaml
MERMAID_ENGINE: playwright
```
- pyppeteer
- **Install pyppeteer**
- pyppeteer
- **Install pyppeteer**
```bash
pip install pyppeteer
```
```bash
pip install pyppeteer
```
- **Use your own Browsers**
- **Use your own Browsers**
pyppeteer alow you use installed browsers, please set the following envirment
```bash
export PUPPETEER_EXECUTABLE_PATH = /path/to/your/chromium or edge or chrome
```
pyppeteer alow you use installed browsers, please set the following envirment
please do not use this command to install browser, it is too old
```bash
export PUPPETEER_EXECUTABLE_PATH = /path/to/your/chromium or edge or chrome
```
```bash
pyppeteer-install
```
please do not use this command to install browser, it is too old
- **modify `config.yaml`**
```bash
pyppeteer-install
```
uncomment MERMAID_ENGINE from config.yaml and change it to `pyppeteer`
- **modify `config.yaml`**
```yaml
MERMAID_ENGINE: pyppeteer
```
uncomment MERMAID_ENGINE from config.yaml and change it to `pyppeteer`
- mermaid.ink
- **modify `config.yaml`**
```yaml
MERMAID_ENGINE: pyppeteer
```
uncomment MERMAID_ENGINE from config.yaml and change it to `ink`
- mermaid.ink
- **modify `config.yaml`**
```yaml
MERMAID_ENGINE: ink
```
uncomment MERMAID_ENGINE from config.yaml and change it to `ink`
Note: this method does not support pdf export.
```yaml
MERMAID_ENGINE: ink
```
Note: this method does not support pdf export.
### Installation by Docker
@ -212,7 +215,7 @@ # Copy the configuration file and make the necessary modifications.
```
| Variable Name | config/key.yaml | env |
| ------------------------------------------ | ----------------------------------------- | ----------------------------------------------- |
|--------------------------------------------|-------------------------------------------|-------------------------------------------------|
| OPENAI_API_KEY # Replace with your own key | OPENAI_API_KEY: "sk-..." | export OPENAI_API_KEY="sk-..." |
| OPENAI_API_BASE # Optional | OPENAI_API_BASE: "https://<YOUR_SITE>/v1" | export OPENAI_API_BASE="https://<YOUR_SITE>/v1" |
@ -286,11 +289,13 @@ ### Code walkthrough
## QuickStart
It is difficult to install and configure the local environment for some users. The following tutorials will allow you to quickly experience the charm of MetaGPT.
It is difficult to install and configure the local environment for some users. The following tutorials will allow you to
quickly experience the charm of MetaGPT.
- [MetaGPT quickstart](https://deepwisdom.feishu.cn/wiki/CyY9wdJc4iNqArku3Lncl4v8n2b)
Try it on Huggingface Space
- https://huggingface.co/spaces/deepwisdom/MetaGPT
## Citation
@ -310,10 +315,12 @@ ## Citation
## Contact Information
If you have any questions or feedback about this project, please feel free to contact us. We highly appreciate your suggestions!
If you have any questions or feedback about this project, please feel free to contact us. We highly appreciate your
suggestions!
- **Email:** alexanderwu@fuzhi.ai
- **GitHub Issues:** For more technical inquiries, you can also create a new issue in our [GitHub repository](https://github.com/geekan/metagpt/issues).
- **GitHub Issues:** For more technical inquiries, you can also create a new issue in
our [GitHub repository](https://github.com/geekan/metagpt/issues).
We will respond to all questions within 2-3 business days.