docs: fix format (#29)

antvis · Nov 22, 2024 · 876d1c8 · 876d1c8
1 parent 1f72d05
commit 876d1c8
Show file tree

Hide file tree

Showing 158 changed files with 23,453 additions and 10,712 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,7 +2,7 @@ name: CI
 
 on:
   push:
-    branches: [master]
+    branches: [main]
     paths:
       - 'src/**'
       - '__tests__/**'
@@ -12,12 +12,15 @@ on:
     paths:
       - 'src/**'
       - '__tests__/**'
+      - 'evaluations/**'
+      - 'knowledges/**'
+      - 'docs/**'
 
 permissions:
   contents: read # to fetch code (actions/checkout)
 
 concurrency:
-  group: '${{ github.workflow }} - ${{ github.head_ref || github.ref }}'
+  group: '${{ github.workflow }} - ${{ github.ref }}'
   cancel-in-progress: true
 
 jobs:

diff --git a/.prettierignore b/.prettierignore
@@ -16,3 +16,7 @@ LICENSE
 # output dist
 dist/**
 
+# evaluations
+evaluations/datastes/recommend/gpt_vis_train.json
+evaluations/datastes/recommend/metrics.json
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @antv/gpt-vis
 
+## 0.2.1
+
+### Patch Changes
+
+- [#26](https://github.com/antvis/GPT-Vis/pull/26) [`e6b4475`](https://github.com/antvis/GPT-Vis/commit/e6b44755e3821c1ed841ded56eee6a289c44fb59) Thanks [@BBSQQ](https://github.com/BBSQQ)! - feat(text): fit antd darkAlgorithm
+
+- [#18](https://github.com/antvis/GPT-Vis/pull/18) [`d73b79b`](https://github.com/antvis/GPT-Vis/commit/d73b79b44b149cd12262de560db9764437091e7e) Thanks [@yvonneyx](https://github.com/yvonneyx)! - feat: add fishbone diagram component
+
 ## 0.2.0
 
 ### Minor Changes

diff --git a/README.md b/README.md
@@ -9,8 +9,7 @@ Components for GPTs, generative AI, and LLM projects. **Not only UI Components**
 <p align="center">
   <a href="https://gpt-vis.antv.vision" target="_blank">Document</a> •
   <a href="/knowledges" target="_blank">Knowledge</a> •
-  <a href="https://huggingface.co/antvis" target="_blank">Huggingface</a> •
-  <a href="https://tbox.alipay.com/share/202410APr1n200110168?platform=WebService" target="_blank">Agent Demo</a>
+  <a href="https://tbox.alipay.com/experience/202410APr1n200110168?id=20241120WZh400101995" target="_blank">Agent Demo</a>
 </p>
 
 <div align="center">
@@ -65,7 +64,8 @@ export default () => {
 };
 ```
 
-## 🛠 Custom renderer
+<details>
+<summary>🛠 Custom renderer</summary>
 
 ```jsx
 import { GPTVisLite, withChartCode, ChartType, Pie } from '@antv/gpt-vis';
@@ -101,6 +101,8 @@ export default () => {
 };
 ```
 
+</details>
+
 ## 🐍 Streamlit
 
 ```python
@@ -118,7 +120,27 @@ Here’s a visualization of Haidilao's food delivery revenue from 2013 to 2022.
 set_gpt_vis(content)
 ```
 
-Learn more 👉 [streamlit-gpt-vis](https://github.com/antvis/GPT-Vis/bindings/streamlit-gpt-vis)
+Learn more 👉 [streamlit-gpt-vis](https://github.com/antvis/GPT-Vis/tree/main/bindings/streamlit-gpt-vis)
+
+## Visual Knowledge
+
+The purpose of the [Visual Knowledge Base](https://github.com/antvis/GPT-Vis/tree/main/knowledges) is to provide a comprehensive and systematic resource to help Agents understand, select, create various data visualization charts. Below are the metrics for generating accurate chart protocols based on the [evaluation dataset](https://github.com/antvis/GPT-Vis/tree/main/evaluations/datastes/chart) through the RAG.
+
+|               |                         |                      |               |                      |                 |         |
+| ------------- | ----------------------- | -------------------- | ------------- | -------------------- | --------------- | ------- |
+| Line(Multi)   | Column(Grouped/Stacked) | Pie                  | Area(Stacked) | Bar(Grouped/Stacked) | Scatter(Bubble) | Heatmap |
+| 40/40         | 25/27                   | 13/14                | 18/18         | 18/20                | 10/10           | 9/10    |
+| Histogram     | Tree Map                | Word Cloud           | Radar         | Dual Axis            | Rich Text NTV   | Pin Map |
+| 15/16         | 13/15                   | 11/12                | 23/23         | 13/14                | 7.3/10          | 10/11   |
+| Network Graph | Mind Map                | Organizational Chart | Flow Diagram  | Fishbone Diagram     |                 |         |
+| 8/10          | 12/14                   | 10/12                | 10/11         | 10/12                |                 |         |
+|               |                         |                      |               |                      |                 |         |
+
+Note: The numbers in the format of X/Y represent the metrics of the respective chart types when evaluated against the dataset.
+
+## 🤖 Chart Recommendation Dataset
+
+The chart recommendation dataset is designed to evaluate or fine-tune large language models on their ability to recommend chart types based on given data. The dataset currently encompasses 16 types of charts, with 1-3 different data scenarios per chart type, and more than 15 chart data instances for each scenario. The dataset is continuously updated, and we welcome contributions of chart data collected from your own use cases. For more detailed information about the dataset, please visit [evaluations/recommend](https://github.com/antvis/GPT-Vis/tree/main/evaluations/recommend/README.md).
 
 ## 💻 Development
 
@@ -133,9 +155,6 @@ $ pnpm dev
 $ pnpm build
 ```
 
-## 🤖 Chart Recommendation Dataset
-The chart recommendation dataset is designed to evaluate or fine-tune large language models on their ability to recommend chart types based on given data. The dataset currently encompasses 16 types of charts, with 1-3 different data scenarios per chart type, and more than 15 chart data instances for each scenario. The dataset is continuously updated, and we welcome contributions of chart data collected from your own use cases. For more detailed information about the dataset, please visit [evaluations/recommend](https://github.com/antvis/GPT-Vis/tree/main/evaluations/recommend/README.md).
-
 ## License
 
 [MIT](./LICENSE)
diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -9,8 +9,7 @@ Components for GPTs, generative AI, and LLM projects. **Not only UI Components**
 <p align="center">
   <a href="https://gpt-vis.antv.vision" target="_blank">文档</a> •
   <a href="/knowledges" target="_blank">知识库</a> •
-  <a href="https://huggingface.co/antvis" target="_blank">Huggingface</a> •
-  <a href="https://tbox.alipay.com/share/202410APr1n200110168?platform=WebService" target="_blank">体验 Agent</a>
+  <a href="https://tbox.alipay.com/experience/202410APr1n200110168?id=20241120WZh400101995" target="_blank">体验 Agent</a>
 </p>
 
 <div align="center">
@@ -65,7 +64,8 @@ export default () => {
 };
 ```
 
-## 🛠 定制渲染器
+<details>
+<summary>🛠 定制渲染器</summary>
 
 ```jsx
 import { GPTVisLite, withChartCode, ChartType, Pie } from '@antv/gpt-vis';
@@ -101,6 +101,8 @@ export default () => {
 };
 ```
 
+</details>
+
 ## 🐍 Streamlit
 
 ```python
@@ -118,9 +120,24 @@ Here’s a visualization of Haidilao's food delivery revenue from 2013 to 2022.
 set_gpt_vis(content)
 ```
 
-更多了解 👉 [streamlit-gpt-vis](https://github.com/antvis/GPT-Vis/bindings/streamlit-gpt-vis)
+更多了解 👉 [streamlit-gpt-vis](https://github.com/antvis/GPT-Vis/tree/main/bindings/streamlit-gpt-vis)
+
+## 🗂 可视化知识库
+
+[可视化知识库](https://github.com/antvis/GPT-Vis/tree/main/knowledges)的目的是为了提供一个全面、系统的资源，帮助 Agent 理解、选择、创建各种数据可视化图表，以下是 Agent 通过 RAG 方式接入知识，根据[评测数据集](https://github.com/antvis/GPT-Vis/tree/main/evaluations/datastes/chart)生成准确图表协议的指标。
+
+|               |                         |                      |               |                      |                 |         |
+| ------------- | ----------------------- | -------------------- | ------------- | -------------------- | --------------- | ------- |
+| Line(Multi)   | Column(Grouped/Stacked) | Pie                  | Area(Stacked) | Bar(Grouped/Stacked) | Scatter(Bubble) | Heatmap |
+| 40/40         | 25/27                   | 13/14                | 18/18         | 18/20                | 10/10           | 9/10    |
+| Histogram     | Tree Map                | Word Cloud           | Radar         | Dual Axis            | Rich Text NTV   | Pin Map |
+| 15/16         | 13/15                   | 11/12                | 23/23         | 13/14                | 7.3/10          | 10/11   |
+| Network Graph | Mind Map                | Organizational Chart | Flow Diagram  | Fishbone Diagram     |                 |         |
+| 8/10          | 12/14                   | 10/12                | 10/11         | 10/12                |                 |         |
+|               |                         |                      |               |                      |                 |         |
 
 ## 🤖 图表模型推荐数据集
+
 图表推荐数据集用于评测/微调大模型在“给定数据，推荐图表类型”任务上的能力。数据集目前涵盖了 16 种图表类型，每种图表类型下 1-3 个不同数据场景，每个场景下 15+ 个图表数据。数据会持续更新，也欢迎向我们贡献你的使用场景中收集的图表数据。数据集详细信息见 [evaluations/recommend](https://github.com/antvis/GPT-Vis/tree/main/evaluations/recommend/README.md)
 
 ## 💻 本地开发