Skip to content

dev: remove install extra info #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thirdgerb merged 1 commit into from
Dec 22, 2024
Merged

dev: remove install extra info #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 1 addition & 11 deletions docs/en/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 0 additions & 6 deletions docs/en/getting_started/chat_with_ghost.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 0 additions & 9 deletions docs/en/getting_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
7 changes: 0 additions & 7 deletions docs/zh-cn/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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): 极简的对话机器人
Expand Down
9 changes: 2 additions & 7 deletions docs/zh-cn/getting_started/chat_with_ghost.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 和体验问题.
Expand All @@ -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) 目录.

如果需要清空它们, 请运行:

Expand Down
21 changes: 6 additions & 15 deletions docs/zh-cn/getting_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Installation

> `GhostOS` 仍然是一个验证中的 AI 项目, 强烈建议安装到 docker 之类的容器中, 而不在本地执行.
> `GhostOS` 仍然是一个验证中的 AI 项目, 强烈建议安装到 docker 之类的容器中, 而不在本地执行.

## PIP install

Expand Down Expand Up @@ -34,31 +34,22 @@ 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
```

## Env

`GhostOS` 依赖各种模型的 `access token`, 默认是从环境变量中读取.
定义这些环境变量有两种方法:
`GhostOS` 依赖各种模型的 `access token`, 默认是从环境变量中读取.
定义这些环境变量有两种方法:

- 使用 `.env` 文件 (自动通过 `dotenv` 读取)

Expand Down