-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add the English version of the README
- Loading branch information
1 parent
6616ac1
commit 75ec719
Showing
2 changed files
with
185 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# <img src="https://mdn.alipayobjects.com/huamei_hdnzbp/afts/img/A*i_UvSZTIo44AAAAAAAAAAAAADjOxAQ/original" width="30"> libro | ||
|
||
语言版本: [English](./README.md) | [中文](./README_zh.md) | ||
|
||
[![Code: CI](https://github.com/difizen/libro/actions/workflows/ci.yml/badge.svg)](https://github.com/difizen/libro/actions/workflows/ci.yml) | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
[![download-image](https://img.shields.io/npm/dm/@difizen/libro-core.svg)](https://www.npmjs.com/package/@difizen/libro-core) | ||
|
||
⚡ libro:灵活定制、轻松集成的 Notebook 产品方案⚡ | ||
|
||
- 提供完整的 Notebook 能力和丰富的周边功能,基于现有组合快速上手。 | ||
- 提供内核级别的扩展能力,所有层次的内容均允许二次开发定制。 | ||
- 定义大模型工作流,内置大模型交互和辅助开发能力。 | ||
|
||
💡 官网:https://libro.difizen.net/ | ||
|
||
如果你也喜欢这个项目,欢迎为我们点亮 🌟🌟🌟 | ||
|
||
![image](https://mdn.alipayobjects.com/huamei_zabatk/afts/img/A*u40VR6qi_E0AAAAAAAAAAAAADvyTAQ/original) | ||
|
||
--- | ||
|
||
## 目录 | ||
|
||
- [快速开始](#快速开始) | ||
- [快速集成](#快速集成) | ||
- [新特性](#新特性) | ||
- [prompt cell](#prompt-cell) | ||
- [sql cell](#sql-cell) | ||
- [架构](#架构) | ||
- [后续计划](#后续计划) | ||
- [更多](#更多) | ||
- [提交issue](#提交issue) | ||
- [贡献代码](#贡献代码) | ||
- [贡献者](#贡献者) | ||
- [联系我们](#联系我们) | ||
|
||
--- | ||
|
||
## 快速开始 | ||
|
||
您需要安装 [libro-server](https://github.com/difizen/libro-server) 来体验完整的 libro 能力。 | ||
|
||
使用 pip: | ||
|
||
```bash | ||
pip install libro | ||
``` | ||
|
||
详情请阅读[快速开始](./apps/docs/docs/quickstart/index.md)。 | ||
|
||
## 快速集成 | ||
|
||
libro 是完全模块化的,您可以自由选择 libro 提供的原生能力模块,也可以选择增加自定义模块来完成二次开发,模块化研发方案您可以通过 [mana](https://github.com/difizen/mana) 来了解。 | ||
|
||
您可以根据自己的需求组装不同的模块,构建自己的 notebook 产品。例如仅因为编辑器相关的模块继承到 IDE 或其他研发环境中,或者引入更多模块来组成 lab 形态的产品。 | ||
|
||
您至少需要安装 jupyter-server 来支持 libro 运行,此时您可以使用 jupyter notebook 的能力,如果需要使用更多 libro 定义的能力,您需要安装 libro-server。 | ||
|
||
详情请阅读[快速集成](./apps/docs/docs/integration/index.md)。 | ||
|
||
### 组件化消费 | ||
|
||
```typescript | ||
import { ManaComponents } from '@difizen/mana-app'; | ||
import { LibroJupyterModule } from "@difizen/libro-jupyter"; | ||
|
||
<ManaComponents.Application | ||
modules={[LibroJupyterModule]} | ||
renderChildren | ||
> | ||
<LibroComponent options={{ id: 'identify' }} /> | ||
</ManaComponents.Application> | ||
``` | ||
|
||
- Application: mana 上下文容器,建议放在应用的外层,多个 libro 示例可以共享上下文。 | ||
- LibroComponent:libro 视图组件,可以将 libro 视图嵌入到任意位置。 | ||
|
||
## 新特性 | ||
|
||
### Prompt Cell | ||
|
||
- 增强直接与大模型交互的能力,支持文本对话,多模态表达等。 | ||
- 增强对于常见输出类型的交互能力,如在输出代码时给出复制、运行等操作能力。 | ||
|
||
![image](https://mdn.alipayobjects.com/huamei_zabatk/afts/img/A*0N2pSra828QAAAAAAAAAAAAADvyTAQ/original) | ||
|
||
### Sql Cell | ||
|
||
- 支持与 sql 的执行交互能力。 | ||
- 连接 sql 数据库即可在 notebook 中写 sql 代码。 | ||
|
||
![image](https://mdn.alipayobjects.com/huamei_zabatk/afts/img/A*u4bWT7pHcGMAAAAAAAAAAAAADvyTAQ/original) | ||
|
||
## 架构 | ||
|
||
![image](https://mdn.alipayobjects.com/huamei_zabatk/afts/img/A*8trZSrPu19sAAAAAAAAAAAAADvyTAQ/original) | ||
|
||
## 后续计划 | ||
|
||
- SQL Cell 接入 | ||
- Copilot 面板接入 | ||
- Libro 在浏览器端执行 | ||
- 版本 Diff 接入 | ||
|
||
## 更多 | ||
|
||
### 提交issue | ||
|
||
😊 我们建议您使用[github issue](https://github.com/difizen/libro/issues) 提交您的疑问, 我们通常会在2日内回复。 | ||
|
||
### 贡献代码 | ||
|
||
🤝 请查阅 [CONTRIBUTING.md](./CONTRIBUTING.md) | ||
|
||
### 贡献者 | ||
|
||
💪 感谢所有的贡献者 | ||
|
||
<a href="https://github.com/difizen/libro/graphs/contributors"> | ||
<img src="https://contributors-img.web.app/image?repo=difizen/libro" alt="List of Contributors"/> | ||
</a> | ||
|
||
### 联系我们 | ||
|
||
💬 [加入 Discord](https://discord.gg/pK8X3guD) | ||
|
||
🤗 [加入钉钉答疑群](https://qr.dingtalk.com/action/joingroup?code=v1,k1,52f1gKWwsZBMrWjXHcQFlOJEQIbbrMO86Iulu3T3ePY=&_dt_no_comment=1&origin=11) | ||
|
||
<img src="https://mdn.alipayobjects.com/huamei_zabatk/afts/img/A*oNhKSblcJfIAAAAAAAAAAAAADvyTAQ/original" width="30%"> |