Skip to content

Commit

Permalink
update images of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@RexWzh
RexWzh committed May 14, 2024
1 parent c23b443 commit 76a219d
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 55 deletions.
77 changes: 49 additions & 28 deletions README-en.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,19 @@

AskChat is a command-line tool for ChatGPT interaction, allowing you to call ChatGPT anytime, anywhere.

Run in the terminal:

![hello](docs/assets/svgs/hello.svg)

Run in Jupyter Notebook:
<div align="center">
<figure>
<figcaption>Run in Terminal</figcaption>
<img src="docs/assets/svgs/hello.svg" alt="hello" width="480">
</figure>
</div>

![jupyter](docs/assets/jupyter.gif)
<div align="center">
<figure>
<figcaption>Jupyter Lab</figcaption>
<img src="docs/assets/jupyter.gif" alt="jupyter" width="480">
</figure>
</div>

## Installation and Configuration

Expand Down Expand Up @@ -64,21 +70,33 @@ In addition, you can use `askchat` for more flexible dialogue and `askenv` to ma

### Usage Examples

1. API debugging, testing default parameters and return results.

![debug](docs/assets/svgs/debug.svg)

2. Get a list of available models.

![validmodels](docs/assets/svgs/validmodels.svg)

3. Multi-turn dialogue, saving dialogues, loading dialogues, etc.
<div align="center">
<figure>
<figcaption>1. API debugging</figcaption>
<img src="docs/assets/svgs/debug.svg" alt="debug" width="480">
</figure>
</div>

![chatlog](docs/assets/svgs/chatlog.svg)
<div align="center">
<figure>
<figcaption>2. Get a list of available models</figcaption>
<img src="docs/assets/svgs/validmodels.svg" alt="validmodels" width="480">
</figure>
</div>

4. Specify parameters, using different models and APIs.
<div align="center">
<figure>
<figcaption>3. Multi-turn dialogue, saving dialogues, loading dialogues, etc.</figcaption>
<img src="docs/assets/svgs/chatlog.svg" alt="chatlog" width="480">
</figure>
</div>

![para-models](docs/assets/svgs/para-models.svg)
<div align="center">
<figure>
<figcaption>4. Specify parameters, using different models and APIs</figcaption>
<img src="docs/assets/svgs/para-models.svg" alt="para-models" width="480">
</figure>
</div>

### Dialogue Management

Expand Down Expand Up @@ -121,9 +139,7 @@ Auxiliary features, such as generating configuration files, debugging logs, prin
| `--generate-config` | `askchat --generate-config` | Generate a configuration file, saved in `~/.askchat/.env` |
| `--debug` | `askchat --debug` | Print debugging logs |
| `--valid-models` | `askchat --valid-models` | Print a list of models containing "gpt" in their names |
| `--all

-valid-models` | `askchat --all-valid-models` | Print all available models |
| `--all-valid-models` | `askchat --all-valid-models` | Print all available models |
| `--version` | `askchat -v` | Version information of `askchat` |

Note: `--all-valid-models` will print all available models, including Embedding, dalle-3, tts, etc., use `--valid-models` to filter these out.
Expand All @@ -134,14 +150,19 @@ Note: `--all-valid-models` will print all available models, including Embedding,

### Examples

1. Create, view, activate, and delete channels.

![askenv](docs/assets/svgs/askenv.svg)

2. Edit channel.

![askenv-config](docs/assets/svgs/editenv.svg)
<div align="center">
<figure>
<figcaption>1. Create channel</figcaption>
<img src="docs/assets/svgs/askenv.svg" alt="askenv" width="480">
</figure>
</div>

<div align="center">
<figure>
<figcaption>2. Edit channel</figcaption>
<img src="docs/assets/svgs/editenv.svg" alt="editenv" width="480">
</figure>
</div>

### Basic Usage

Expand Down
63 changes: 36 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,17 @@
[English](README-en.md) | [简体中文](README.md)
</div>

AskChat 是一个通过命令行运行的，无界面的 ChatGPT 交互工具，随时随地调用 ChatGPT。
通过命令行运行的 ChatGPT 交互工具，随时随地调用 ChatGPT。

在终端调用：

![hello](docs/assets/svgs/hello.svg)

在 Jupyter Notebook 中调用：
<div align="center">
<div style="margin-top: 10px; color: #555;">终端调用</div>
<img src="docs/assets/svgs/hello.svg" alt="hello" width="480">
</div>

![jupyter](docs/assets/jupyter.gif)
<div align="center">
<div style="margin-top: 10px; color: #555;">Jupyter Lab</div>
<img src="docs/assets/jupyter.gif" alt="jupyter" width="480">
</div>

## 安装及配置

Expand Down Expand Up @@ -64,21 +66,25 @@ ask hello world

### 使用示例

1. API 调试，测试默认参数和返回结果。

![debug](docs/assets/svgs/debug.svg)

2. 获取可用模型列表。

![validmodels](docs/assets/svgs/validmodels.svg)

3. 多轮对话，保存对话，加载对话等。
<div align="center">
<div style="margin-top: 10px; color: #555;">1. API 调试</div>
<img src="docs/assets/svgs/debug.svg" alt="debug" width="480">
</div>

![chatlog](docs/assets/svgs/chatlog.svg)
<div align="center">
<div style="margin-top: 10px; color: #555;">2. 获取可用模型列表</div>
<img src="docs/assets/svgs/validmodels.svg" alt="validmodels" width="480">
</div>

4. 指定参数，使用不同的模型和 API。
<div align="center">
<div style="margin-top: 10px; color: #555;">3. 多轮对话，保存对话，加载对话等</div>
<img src="docs/assets/svgs/chatlog.svg" alt="chatlog" width="480">
</div>

![para-models](docs/assets/svgs/para-models.svg)
<div align="center">
<div style="margin-top: 10px; color: #555;">4. 指定参数，使用不同的模型和 API</div>
<img src="docs/assets/svgs/para-models.svg" alt="para-models" width="480">
</div>

### 对话管理

Expand Down Expand Up @@ -132,14 +138,15 @@ ask hello world

### 示例

1. 创建，查看，激活和删除渠道

![askenv](docs/assets/svgs/askenv.svg)

2. 编辑渠道

![askenv-config](docs/assets/svgs/editenv.svg)
<div align="center">
<div style="margin-top: 10px; color: #555;">1. 创建渠道</div>
<img src="docs/assets/svgs/askenv.svg" alt="askenv" width="480">
</div>

<div align="center">
<div style="margin-top: 10px; color: #555;">2. 编辑渠道</div>
<img src="docs/assets/svgs/editenv.svg" alt="editenv" width="480">
</div>

### 基本用法

Expand Down Expand Up @@ -192,6 +199,8 @@ ask hello world
askenv config [name] [-a API_KEY] [-b BASE_URL] [--api-base API_BASE] [-m MODEL]
```

## 问题和反馈
## 问

题和反馈

使用过程中有任何问题或建议，欢迎提交 [Issue](https://github.com/cubenlp/askchat/issues)。

0 comments on commit 76a219d

Please sign in to comment.