Skip to content

Commit 0a635aa

Browse files
committed
docs: fix broken ProjectRepo import, dead link and typos
- README_CN/JA/FR: 'from metagpt.software_company import generate_repo, ProjectRepo' raises ImportError — software_company has no ProjectRepo; import it from metagpt.utils.project_repo like the English README does - README_CN: the cli_install link missed the /main/zh docs segment and returned HTTP 500; sibling links in the same file use /main/zh/ - install/cli_install.md + README_JA: 'config.yml' -> config2.yaml (the only config file that exists), Chrominum -> Chromium, envirment -> environment, add missing verb 'to set' - data_interpreter/sela experimenter: return annotation referenced a nonexistent 'Interpreter' class -> DataInterpreter - tot.py: solve() docstring documented a 'strategy' arg it doesn't take (copied from _initialize_solver)
1 parent 47e4f1d commit 0a635aa

7 files changed

Lines changed: 14 additions & 12 deletions

File tree

docs/README_CN.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,13 @@ metagpt "创建一个 2048 游戏" # 这将在 ./workspace 创建一个仓库
4141
或者您可以将其作为库使用
4242

4343
```python
44-
from metagpt.software_company import generate_repo, ProjectRepo
44+
from metagpt.software_company import generate_repo
45+
from metagpt.utils.project_repo import ProjectRepo
4546
repo: ProjectRepo = generate_repo("创建一个 2048 游戏") # 或 ProjectRepo("<路径>")
4647
print(repo) # 它将打印出仓库结构及其文件
4748
```
4849

49-
详细的安装请参考 [cli_install](https://docs.deepwisdom.ai/guide/get_started/installation.html#install-stable-version)
50+
详细的安装请参考 [cli_install](https://docs.deepwisdom.ai/main/zh/guide/get_started/installation.html#install-stable-version)
5051

5152
### Docker安装
5253
> 注意:在Windows中,你需要将 "/opt/metagpt" 替换为Docker具有创建权限的目录,比如"D:\Users\x\metagpt"

docs/README_FR.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,8 @@ metagpt "Create a 2048 game" # ceci créera un repo dans ./workspace
100100
ou l'utiliser comme bibliothèque
101101

102102
```python
103-
from metagpt.software_company import generate_repo, ProjectRepo
103+
from metagpt.software_company import generate_repo
104+
from metagpt.utils.project_repo import ProjectRepo
104105
repo: ProjectRepo = generate_repo("Create a 2048 game") # ou ProjectRepo("<path>")
105106
print(repo) # il affichera la structure du repo avec les fichiers
106107
```

docs/README_JA.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ metagpt "2048ゲームを作成する" # これにより ./workspace にリポ
6262
または、ライブラリとして使用することもできます
6363

6464
```python
65-
from metagpt.software_company import generate_repo, ProjectRepo
65+
from metagpt.software_company import generate_repo
66+
from metagpt.utils.project_repo import ProjectRepo
6667
repo: ProjectRepo = generate_repo("2048ゲームを作成する") # または ProjectRepo("<パス>")
6768
print(repo) # リポジトリの構造とファイルを出力します
6869
```
@@ -78,7 +79,7 @@ Chromium のダウンロードをスキップすることができます。
7879
npm install @mermaid-js/mermaid-cli
7980
```
8081

81-
- config.yml に mmdc のコンフィグを記述するのを忘れないこと
82+
- config2.yaml に mmdc のコンフィグを記述するのを忘れないこと
8283

8384
```yml
8485
puppeteer_config: "./config/puppeteer-config.json"
@@ -98,7 +99,7 @@ Chromium のダウンロードをスキップすることができます。
9899

99100
- **必要なブラウザのインストール**
100101

101-
PDF変換をサポートするには、Chrominumをインストールしてください
102+
PDF変換をサポートするには、Chromiumをインストールしてください
102103

103104
```bash
104105
playwright install --with-deps chromium

docs/install/cli_install.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ sudo npm install -g @mermaid-js/mermaid-cli
4545
npm install @mermaid-js/mermaid-cli
4646
```
4747

48-
- don't forget to the configuration for mmdc path in config.yml
48+
- don't forget to set the configuration for the mmdc path in config2.yaml
4949

5050
```yaml
5151
mermaid:
@@ -66,7 +66,7 @@ sudo npm install -g @mermaid-js/mermaid-cli
6666

6767
- **Install the Required Browsers**
6868

69-
to support PDF conversion, please install Chrominum.
69+
to support PDF conversion, please install Chromium.
7070

7171
```bash
7272
playwright install --with-deps chromium
@@ -90,7 +90,7 @@ sudo npm install -g @mermaid-js/mermaid-cli
9090

9191
- **Use your own Browsers**
9292

93-
pyppeteer allows you use installed browsers, please set the following envirment
93+
pyppeteer allows you use installed browsers, please set the following environment
9494

9595
```bash
9696
export PUPPETEER_EXECUTABLE_PATH = /path/to/your/chromium or edge or chrome

metagpt/ext/sela/experimenter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ async def llm_extract_score(self):
129129
return score_dict
130130

131131
@model_validator(mode="after")
132-
def set_plan_and_tool(self) -> "Interpreter":
132+
def set_plan_and_tool(self) -> "DataInterpreter":
133133
if self.planner.plan.goal != "":
134134
self.set_actions([WriteAnalysisCode])
135135
self._set_state(0)

metagpt/roles/di/data_interpreter.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class DataInterpreter(Role):
4747
user_requirement: str = ""
4848

4949
@model_validator(mode="after")
50-
def set_plan_and_tool(self) -> "Interpreter":
50+
def set_plan_and_tool(self) -> "DataInterpreter":
5151
self._set_react_mode(react_mode=self.react_mode, max_react_loop=self.max_react_loop, auto_run=self.auto_run)
5252
self.use_plan = (
5353
self.react_mode == "plan_and_act"

metagpt/strategy/tot.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,6 @@ async def solve(self, init_prompt=""):
269269
270270
Args:
271271
init_prompt (str): The initial prompt for the solver.
272-
strategy (str): The strategy to use for solving.
273272
274273
Returns:
275274
Any: The solution obtained using the selected strategy.

0 commit comments

Comments
 (0)