Skip to content

Commit

Permalink
updatge doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yanqingmen committed Mar 9, 2023
1 parent f0749e3 commit 21c1640
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.en.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# ask-api
#### [中文文档](./README.md)

#### Description
ask-api is a python framework, based on the llm models, which can help you to understand your python code by asking questions, and provide the following capabilities:
Expand All @@ -9,7 +10,6 @@ ask-api is a python framework, based on the llm models, which can help you to un

#### Installation (to be improved)
```shell
# pip install ask-api
```

#### Development plan (in progress)
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# ask-api
#### [EN DOC](./README.en.md)

#### 说明
ask-api 是一个python框架,借助LLM(目前支持chatgpt-api)模型的代码理解能力,让你能够与你的python代码对话,提供包括但不限于如下的能力:
Expand All @@ -15,6 +16,7 @@ ask-api 是一个python框架,借助LLM(目前支持chatgpt-api)模型的代

- [x] 基于openai的chatgpt-api,支持对python函数进行提问,了解函数的用途。
- [X] 支持中文以及英文两种类型的prompt。
- [ ] 通过pip安装。
- [ ] 支持自定义的prompt。
- [X] 支持通过自然语言命令来执行函数。
- [ ] 支持其他LLM模型或api作为底层算法支持
Expand Down

0 comments on commit 21c1640

Please sign in to comment.