Skip to content

Commit

Permalink
(doc) simplified the start process.
Browse files Browse the repository at this point in the history
  • Loading branch information
SummerFall1819 committed Jan 7, 2025
1 parent 40e9dd9 commit a2daeb7
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 26 deletions.
9 changes: 1 addition & 8 deletions agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,7 @@ To fully experience the proactive agent, you will have to install additional dep
**To directly run the model, you should configurate an api_key named activeagent, which will be directly used for calling API. See the comment in example_config.toml**.
It is suggested that you also change the `default_completion_model` to `activeagent` to avoid potential KeyErrors.

1. Running a server.
```bash
python main.py
```
This server is in charge of the functions the agent will be using. If succeeded, the terminal will show information.
- For windows user, this server will register an AUMID for our agent, which is necessary for our notifications. The script will create a `appid.txt` file, which contains the AUMID. **DO NOT DELETE THIS FILE UNLESS YOU WANT TO GENERATE A NEW AMUID**.

2. With the previous terminal open, open a new terminal and run command:
2. Run command:
```bash
python ragent.py --platform PC [--chromes <the chrome you want to watch> --interval <interval seconds for each turn>]
python ragent.py --platform PC --chromes explorer.exe,mesdge.exe --interval 10
Expand Down
10 changes: 1 addition & 9 deletions agent/README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,7 @@
**モデルを直接実行するには、activeagent という名前の API キーを設定する必要があります。これは直接呼び出しに使用されます。example_config のコメントを参照してください。**
同様に、KeyErrorエラーの可能性を回避するために、`default_completion_model ``activeagent` に置き換えることをお勧めします。

2. サーバーを実行します。
コマンドを実行します。
```bash
python main.py
```
成功した場合、ターミナルに情報が表示されます。
- Windows ユーザーの場合、このサーバーは通知のために AUMID を登録します。スクリプトは AUMID を含む `appid.txt` ファイルを作成します。**新しい AUMID を生成する場合を除き、このファイルを削除しないでください。**

3. 前のターミナルを開いたままにして、新しいターミナルを開き、次のコマンドを実行します。
2. Proactive Agent を実行します。
```bash
python ragent.py --platform PC [--chromes <監視するブラウザの名前> --interval <各ターンの間隔秒数>]
python ragent.py --platform PC --chromes explorer.exe,mesdge.exe --interval 10
Expand Down
10 changes: 1 addition & 9 deletions agent/README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,7 @@
**为了能够直接运行模型,你应当配置一个名称为 activeagent 的令牌,该令牌将会被直接调用。请参考 example_config 的注释。**
同样建议您将 `default_completion_model` 更换为 `activeagent` 以避免可能的 KeyError 错误。

2. 运行服务器。
运行指令
```bash
python main.py
```
如果成功,控制台将输出信息。
- 对于 windows 用户,该服务器将会为我们的智能体注册一个 AUMID, 这对于我们的桌面通知是必须的。脚本将会创建一个 `appid.txt` 文件,其中包含我们的 AUMID. **请勿删除此文件,除非你想要生成一个新的 AUMID**

3. 保留之前的控制台,打开新的控制台并运行指令
2. 运行指令
```bash
python ragent.py --platform PC [--chromes <你希望监听的浏览器名称> --interval <每轮之间的间隔>]
python ragent.py --platform PC --chromes explorer.exe,mesdge.exe --interval 10
Expand Down

0 comments on commit a2daeb7

Please sign in to comment.