Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sunshinesmilelk authored and october-rain committed Oct 14, 2024
1 parent c32e2ae commit 723a428
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,18 @@ import { LibroJupyterModule } from "@difizen/libro-jupyter";

- Enhances the ability to interact directly with large models, supporting text conversations, multimodal expressions, and more.
- Improves interaction capabilities for common output types, such as providing options to copy or run code when outputting it.
- Built-in OpenAI models are available, and you can also extend models in the following ways:
- Define variables for LLMs, agents, and other dialogue objects based on Langchain, which can be directly used in Prompt Cells.
- Extend your own models based on libro-ai.

![image](./apps/docs/public/prompt_cell.png)
![image](./apps/docs/public/prompt_cell.gif)

### Sql Cell

- Supports interaction capabilities for executing SQL commands.
- Connect to SQL databases to write SQL code directly in the notebook.

![image](./apps/docs/public/sql_cell.png)
![image](./apps/docs/public/sql_cell.gif)

## Technical Architecture

Expand Down
9 changes: 7 additions & 2 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,20 @@ import { LibroJupyterModule } from "@difizen/libro-jupyter";

- 增强直接与大模型交互的能力,支持文本对话,多模态表达等。
- 增强对于常见输出类型的交互能力,如在输出代码时给出复制、运行等操作能力。
- 内置了 OpenAI 系列模型,您还可以通过以下方式扩展模型~
- 基于 langchain 定义 llm、agent 等可对话对象的变量,他们可以直接用在 Prompt cell 中。
- 基于 libro-ai 扩展自己的模型。
- 支持选择聊天标识,使得选择该聊天标识的 Prompt Cell 都在一个聊天上下文中。
- 支持 Prompt Cell 保存为一个变量,该变量即为 langchain 的 AIMessage。

![image](./apps/docs/public/prompt_cell_zh.png)
![image](./apps/docs/public/prompt_cell_zh.gif)

### Sql Cell

- 支持与 sql 的执行交互能力。
- 连接 sql 数据库即可在 notebook 中写 sql 代码。

![image](./apps/docs/public/sql_cell.png)
![image](./apps/docs/public/sql_cell_zh.gif)

## 架构

Expand Down
Binary file added apps/docs/public/prompt_cell.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added apps/docs/public/sql_cell.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 723a428

Please sign in to comment.