From 2e73cf4c9b24db9799753f320e5102a538250d87 Mon Sep 17 00:00:00 2001 From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com> Date: Tue, 15 Oct 2024 00:29:42 +0530 Subject: [PATCH 01/10] Create README.md --- docs/README.md | 187 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 187 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..a151a1f0f0 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,187 @@ + +# MetaGPT: The Multi-Agent Framework + +
+ ++Assign different roles to GPTs to form a collaborative entity for complex tasks. +
+ + + + + +## News +🚀 Mar. 29, 2024: [v0.8.0](https://github.com/geekan/MetaGPT/releases/tag/v0.8.0) released. Now you can use Data Interpreter ([arxiv](https://arxiv.org/abs/2402.18679), [example](https://docs.deepwisdom.ai/main/en/DataInterpreter/), [code](https://github.com/geekan/MetaGPT/tree/main/examples/di)) via pypi package import. Meanwhile, we integrated RAG module and supported multiple new LLMs. + +🚀 Feb. 08, 2024: [v0.7.0](https://github.com/geekan/MetaGPT/releases/tag/v0.7.0) released, supporting assigning different LLMs to different Roles. We also introduced [Data Interpreter](https://github.com/geekan/MetaGPT/blob/main/examples/di/README.md), a powerful agent capable of solving a wide range of real-world problems. + +🚀 Jan. 16, 2024: Our paper [MetaGPT: Meta Programming for A Multi-Agent Collaborative Framework +](https://openreview.net/forum?id=VtmBAGCN7o) accepted for **oral presentation (top 1.2%)** at ICLR 2024, **ranking #1** in the LLM-based Agent category. + +🚀 Jan. 03, 2024: [v0.6.0](https://github.com/geekan/MetaGPT/releases/tag/v0.6.0) released, new features include serialization, upgraded OpenAI package and supported multiple LLM, provided [minimal example for debate](https://github.com/geekan/MetaGPT/blob/main/examples/debate_simple.py) etc. + +🚀 Dec. 15, 2023: [v0.5.0](https://github.com/geekan/MetaGPT/releases/tag/v0.5.0) released, introducing some experimental features such as incremental development, multilingual, multiple programming languages, etc. + +🔥 Nov. 08, 2023: MetaGPT is selected into [Open100: Top 100 Open Source achievements](https://www.benchcouncil.org/evaluation/opencs/annual.html). + +🔥 Sep. 01, 2023: MetaGPT tops GitHub Trending Monthly for the **17th time** in August 2023. + +🌟 Jun. 30, 2023: MetaGPT is now open source. + +🌟 Apr. 24, 2023: First line of MetaGPT code committed. + +## Software Company as Multi-Agent System + +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) + +Software Company Multi-Agent Schematic (Gradually Implementing)
+ +## Get Started + +### Installation + +> Ensure that Python 3.9 or later, but less than 3.12, is installed on your system. You can check this by using: `python --version`. +> You can use conda like this: `conda create -n metagpt python=3.9 && conda activate metagpt` + +```bash +pip install --upgrade metagpt +# or `pip install --upgrade git+https://github.com/geekan/MetaGPT.git` +# or `git clone https://github.com/geekan/MetaGPT && cd MetaGPT && pip install --upgrade -e .` +``` + +For detailed installation guidance, please refer to [cli_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-stable-version) + or [docker_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-with-docker) + +### Configuration + +You can init the config of MetaGPT by running the following command, or manually create `~/.metagpt/config2.yaml` file: +```bash +# Check https://docs.deepwisdom.ai/main/en/guide/get_started/configuration.html for more details +metagpt --init-config # it will create ~/.metagpt/config2.yaml, just modify it to your needs +``` + +You can configure `~/.metagpt/config2.yaml` according to the [example](https://github.com/geekan/MetaGPT/blob/main/config/config2.example.yaml) and [doc](https://docs.deepwisdom.ai/main/en/guide/get_started/configuration.html): + +```yaml +llm: + api_type: "openai" # or azure / ollama / groq etc. Check LLMType for more options + model: "gpt-4-turbo" # or gpt-3.5-turbo + base_url: "https://api.openai.com/v1" # or forward url / other llm url + api_key: "YOUR_API_KEY" +``` + +### Usage + +After installation, you can use MetaGPT at CLI + +```bash +metagpt "Create a 2048 game" # this will create a repo in ./workspace +``` + +or use it as library + +```python +from metagpt.software_company import generate_repo, ProjectRepo +repo: ProjectRepo = generate_repo("Create a 2048 game") # or ProjectRepo("
-
+
From 936a9a152ed54e2ce96e0913a8e19833814b6877 Mon Sep 17 00:00:00 2001
From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com>
Date: Tue, 15 Oct 2024 00:33:47 +0530
Subject: [PATCH 03/10] Update README_JA.md
---
docs/README_JA.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README_JA.md b/docs/README_JA.md
index 8981361a80..37f2464aa6 100644
--- a/docs/README_JA.md
+++ b/docs/README_JA.md
@@ -10,7 +10,7 @@
-
+
From 1dfc1bb2ca59690667da6401593cacd4ec986f0e Mon Sep 17 00:00:00 2001
From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com>
Date: Tue, 15 Oct 2024 00:44:08 +0530
Subject: [PATCH 04/10] Delete docs/README.md
---
docs/README.md | 187 -------------------------------------------------
1 file changed, 187 deletions(-)
delete mode 100644 docs/README.md
diff --git a/docs/README.md b/docs/README.md
deleted file mode 100644
index a151a1f0f0..0000000000
--- a/docs/README.md
+++ /dev/null
@@ -1,187 +0,0 @@
-
-# MetaGPT: The Multi-Agent Framework
-
-
-Assign different roles to GPTs to form a collaborative entity for complex tasks. -
- - - - - -## News -🚀 Mar. 29, 2024: [v0.8.0](https://github.com/geekan/MetaGPT/releases/tag/v0.8.0) released. Now you can use Data Interpreter ([arxiv](https://arxiv.org/abs/2402.18679), [example](https://docs.deepwisdom.ai/main/en/DataInterpreter/), [code](https://github.com/geekan/MetaGPT/tree/main/examples/di)) via pypi package import. Meanwhile, we integrated RAG module and supported multiple new LLMs. - -🚀 Feb. 08, 2024: [v0.7.0](https://github.com/geekan/MetaGPT/releases/tag/v0.7.0) released, supporting assigning different LLMs to different Roles. We also introduced [Data Interpreter](https://github.com/geekan/MetaGPT/blob/main/examples/di/README.md), a powerful agent capable of solving a wide range of real-world problems. - -🚀 Jan. 16, 2024: Our paper [MetaGPT: Meta Programming for A Multi-Agent Collaborative Framework -](https://openreview.net/forum?id=VtmBAGCN7o) accepted for **oral presentation (top 1.2%)** at ICLR 2024, **ranking #1** in the LLM-based Agent category. - -🚀 Jan. 03, 2024: [v0.6.0](https://github.com/geekan/MetaGPT/releases/tag/v0.6.0) released, new features include serialization, upgraded OpenAI package and supported multiple LLM, provided [minimal example for debate](https://github.com/geekan/MetaGPT/blob/main/examples/debate_simple.py) etc. - -🚀 Dec. 15, 2023: [v0.5.0](https://github.com/geekan/MetaGPT/releases/tag/v0.5.0) released, introducing some experimental features such as incremental development, multilingual, multiple programming languages, etc. - -🔥 Nov. 08, 2023: MetaGPT is selected into [Open100: Top 100 Open Source achievements](https://www.benchcouncil.org/evaluation/opencs/annual.html). - -🔥 Sep. 01, 2023: MetaGPT tops GitHub Trending Monthly for the **17th time** in August 2023. - -🌟 Jun. 30, 2023: MetaGPT is now open source. - -🌟 Apr. 24, 2023: First line of MetaGPT code committed. - -## Software Company as Multi-Agent System - -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) - -Software Company Multi-Agent Schematic (Gradually Implementing)
- -## Get Started - -### Installation - -> Ensure that Python 3.9 or later, but less than 3.12, is installed on your system. You can check this by using: `python --version`. -> You can use conda like this: `conda create -n metagpt python=3.9 && conda activate metagpt` - -```bash -pip install --upgrade metagpt -# or `pip install --upgrade git+https://github.com/geekan/MetaGPT.git` -# or `git clone https://github.com/geekan/MetaGPT && cd MetaGPT && pip install --upgrade -e .` -``` - -For detailed installation guidance, please refer to [cli_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-stable-version) - or [docker_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-with-docker) - -### Configuration - -You can init the config of MetaGPT by running the following command, or manually create `~/.metagpt/config2.yaml` file: -```bash -# Check https://docs.deepwisdom.ai/main/en/guide/get_started/configuration.html for more details -metagpt --init-config # it will create ~/.metagpt/config2.yaml, just modify it to your needs -``` - -You can configure `~/.metagpt/config2.yaml` according to the [example](https://github.com/geekan/MetaGPT/blob/main/config/config2.example.yaml) and [doc](https://docs.deepwisdom.ai/main/en/guide/get_started/configuration.html): - -```yaml -llm: - api_type: "openai" # or azure / ollama / groq etc. Check LLMType for more options - model: "gpt-4-turbo" # or gpt-3.5-turbo - base_url: "https://api.openai.com/v1" # or forward url / other llm url - api_key: "YOUR_API_KEY" -``` - -### Usage - -After installation, you can use MetaGPT at CLI - -```bash -metagpt "Create a 2048 game" # this will create a repo in ./workspace -``` - -or use it as library - -```python -from metagpt.software_company import generate_repo, ProjectRepo -repo: ProjectRepo = generate_repo("Create a 2048 game") # or ProjectRepo("
-
+
From 79e7a64d445e76dbfab894e58a7acfc9e1d19558 Mon Sep 17 00:00:00 2001
From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com>
Date: Tue, 15 Oct 2024 03:21:48 +0530
Subject: [PATCH 06/10] Update README_CN.md
---
docs/README_CN.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README_CN.md b/docs/README_CN.md
index 4e7866d839..eaaa2c2b61 100644
--- a/docs/README_CN.md
+++ b/docs/README_CN.md
@@ -9,7 +9,7 @@
-
+
From 78f0fb33f2d6d62be539691adb0cb0266a522799 Mon Sep 17 00:00:00 2001
From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com>
Date: Tue, 15 Oct 2024 03:22:28 +0530
Subject: [PATCH 07/10] Update README_CN.md
---
docs/README_CN.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README_CN.md b/docs/README_CN.md
index eaaa2c2b61..e34d7a9ac9 100644
--- a/docs/README_CN.md
+++ b/docs/README_CN.md
@@ -10,7 +10,7 @@
-
+
From c2125d77c49a65f04b10809edab7862d77d0a8b2 Mon Sep 17 00:00:00 2001
From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com>
Date: Tue, 15 Oct 2024 03:22:54 +0530
Subject: [PATCH 08/10] Update README_CN.md
---
docs/README_CN.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/README_CN.md b/docs/README_CN.md
index e34d7a9ac9..c51084f53b 100644
--- a/docs/README_CN.md
+++ b/docs/README_CN.md
@@ -11,7 +11,7 @@
-
+
From f05863c04f92c100e0dfbf4dd1a0419f0ecb27ef Mon Sep 17 00:00:00 2001
From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com>
Date: Tue, 15 Oct 2024 03:23:26 +0530
Subject: [PATCH 09/10] Update README_JA.md
---
docs/README_JA.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/README_JA.md b/docs/README_JA.md
index 0006e08069..5cebb539b2 100644
--- a/docs/README_JA.md
+++ b/docs/README_JA.md
@@ -9,9 +9,9 @@
-
+
-
+
From d27fdbff212f406a7281ff1a2affef11a1832d1c Mon Sep 17 00:00:00 2001
From: SEIKH NABAB UDDIN <93948993+nababuddin@users.noreply.github.com>
Date: Tue, 15 Oct 2024 03:23:56 +0530
Subject: [PATCH 10/10] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 336b6097a8..a151a1f0f0 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@