From 946b37c22d880c53c52d7388ef9e4435770158c6 Mon Sep 17 00:00:00 2001 From: zhuming Date: Mon, 23 Dec 2024 04:41:12 +0800 Subject: [PATCH] dev: remove install extra info --- README.md | 10 --------- docs/en/README.md | 12 +---------- docs/en/getting_started/chat_with_ghost.md | 6 ------ docs/en/getting_started/installation.md | 9 -------- docs/zh-cn/README.md | 7 ------- docs/zh-cn/getting_started/chat_with_ghost.md | 9 ++------ docs/zh-cn/getting_started/installation.md | 21 ++++++------------- 7 files changed, 9 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index e41e620a..9d45a9a5 100644 --- a/README.md +++ b/README.md @@ -85,16 +85,6 @@ that can be instructed to call functions or methods within the file through natu ghostos web [my_path_file_path] ``` -Install the extra dependencies for realtime: - -```bash -# install realtime dependencies: pyaudio and websockets -pip install ghostos[realtime] - -# install spherov2 if you have sphero bolt -pip install ghostos[sphero] -``` - ou can create a local Python file and define your own Agents. For more details * [Chatbot](docs/zh-cn/usages/chatbot.md): simplest chatbot diff --git a/docs/en/README.md b/docs/en/README.md index 4d05fa7b..07443a5d 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -86,17 +86,7 @@ that can be instructed to call functions or methods within the file through natu ghostos web [my_path_file_path] ``` -Install the extra dependencies for realtime: - -```bash -# install realtime dependencies: pyaudio and websockets -pip install ghostos[realtime] - -# install spherov2 if you have sphero bolt -pip install ghostos[sphero] -``` - -ou can create a local Python file and define your own Agents. For more details +you can create a local Python file and define your own Agents. For more details * [Chatbot](/en/usages/chatbot.md): simplest chatbot * [MossAgent](/en/usages/moss_agent.md): an agent that can interact with the python module diff --git a/docs/en/getting_started/chat_with_ghost.md b/docs/en/getting_started/chat_with_ghost.md index f75ad4b3..b8dc1945 100644 --- a/docs/en/getting_started/chat_with_ghost.md +++ b/docs/en/getting_started/chat_with_ghost.md @@ -28,12 +28,6 @@ methods. `GhostOS` will automatically reflect the code to generate the context v `GhostOS` Implements [OpenAI Realtime Beta](https://platform.openai.com/docs/api-reference/realtime). -To use it, you need to install the relevant libraries first: - -```bash -pip install ghostos[realtime] -``` - For configuration details of the real-time model, see [configuration](./configuration.md). > There are still many bugs and experience issues with the current real-time model. diff --git a/docs/en/getting_started/installation.md b/docs/en/getting_started/installation.md index a37821bf..33d1293b 100644 --- a/docs/en/getting_started/installation.md +++ b/docs/en/getting_started/installation.md @@ -37,15 +37,6 @@ natural language dialogue. ghostos web [my_path_file_path] ``` -## Extra - -Install extra dependencies: - -```bash -pip install ghostos[sphero] # 安装 sphero 类库 -pip install ghostos[realtime] # 安装 realtime 相关类库. pyaudio 和 websockets -``` - ## Workspace `GhostOS` is currently using local files to store runtime data, so it's necessary to initialize a workspace. diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index 4b027b06..d3a00c1c 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -78,13 +78,6 @@ ghostos web ghostos.demo.agents.jojo ghostos web [my_path_file_path] ``` -安装更多关联依赖: - -```bash -pip install ghostos[sphero] # 安装 sphero 类库 -pip install ghostos[realtime] # 安装 realtime 相关类库. pyaudio 和 websockets -``` - 可以通过创建本地 python 文件, 定义出自己的 Agents. 详情请见: * [Chatbot](/zh-cn/usages/chatbot.md): 极简的对话机器人 diff --git a/docs/zh-cn/getting_started/chat_with_ghost.md b/docs/zh-cn/getting_started/chat_with_ghost.md index d3a10b7c..7b351713 100644 --- a/docs/zh-cn/getting_started/chat_with_ghost.md +++ b/docs/zh-cn/getting_started/chat_with_ghost.md @@ -28,12 +28,6 @@ ghostos web ghostos.demo.agents.jojo `GhostOS` 实现了 [OpenAI Realtime Beta](https://platform.openai.com/docs/api-reference/realtime). -想要使用它, 需要先安装相关库: - -```bash -pip install ghostos[realtime] -``` - 对 realtime 模型的配置详见 [configuration](./configuration.md). > 目前的 realtime 还有很多 bug 和体验问题. @@ -48,7 +42,8 @@ pip install ghostos[realtime] * images and audio: 过程中的图片和音频. * logs: 运行时日志. -所有这类运行时文件, 都保存在 [\[workspace\]/runtime](https://github.com/ghost-in-moss/GhostOS/tree/main/ghostos/app/runtime) 目录. +所有这类运行时文件, +都保存在 [\[workspace\]/runtime](https://github.com/ghost-in-moss/GhostOS/tree/main/ghostos/app/runtime) 目录. 如果需要清空它们, 请运行: diff --git a/docs/zh-cn/getting_started/installation.md b/docs/zh-cn/getting_started/installation.md index e44d1a6a..17cfbd42 100644 --- a/docs/zh-cn/getting_started/installation.md +++ b/docs/zh-cn/getting_started/installation.md @@ -1,6 +1,6 @@ # Installation -> `GhostOS` 仍然是一个验证中的 AI 项目, 强烈建议安装到 docker 之类的容器中, 而不在本地执行. +> `GhostOS` 仍然是一个验证中的 AI 项目, 强烈建议安装到 docker 之类的容器中, 而不在本地执行. ## PIP install @@ -34,22 +34,13 @@ ghostos web ghostos.demo.agents.jojo ghostos web [my_path_file_path] ``` -## Extra - -安装关联依赖: - -```bash -pip install ghostos[sphero] # 安装 sphero 类库 -pip install ghostos[realtime] # 安装 realtime 相关类库. pyaudio 和 websockets -``` - ## Workspace -`GhostOS` 当前版本使用本地文件来存运行时数据. 所以需要初始化一个 workspace. +`GhostOS` 当前版本使用本地文件来存运行时数据. 所以需要初始化一个 workspace. -运行 `ghostos init` 可以用脚本复制 workspace 到当前目录. +运行 `ghostos init` 可以用脚本复制 workspace 到当前目录. -`GhostOS` 在运行中产生的数据会存放到这个目录下. 当需要清除历史数据时, 请执行: +`GhostOS` 在运行中产生的数据会存放到这个目录下. 当需要清除历史数据时, 请执行: ```bash ghostos clear-runtime @@ -57,8 +48,8 @@ ghostos clear-runtime ## Env -`GhostOS` 依赖各种模型的 `access token`, 默认是从环境变量中读取. -定义这些环境变量有两种方法: +`GhostOS` 依赖各种模型的 `access token`, 默认是从环境变量中读取. +定义这些环境变量有两种方法: - 使用 `.env` 文件 (自动通过 `dotenv` 读取)