Skip to content

Commit c67d9ba

Browse files
committed
docs: 更新安装说明,统一使用 hyperextract 包名并优化 CLI 安装指令
1 parent 0277537 commit c67d9ba

25 files changed

Lines changed: 210 additions & 88 deletions

File tree

README.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
[📖 English Version](./README.md) · [中文版](./README_ZH.md)
1717

18+
[![PyPI Version](https://img.shields.io/pypi/v/hyperextract)](https://pypi.org/project/hyperextract/)
1819
[![Python Version](https://img.shields.io/badge/python-3.11%2B-blue)](https://python.org)
1920
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
2021
[![Status](https://img.shields.io/badge/status-active-success)]()
@@ -26,13 +27,24 @@
2627
2728
<br/>
2829

29-
<img src="docs/assets/hero.png" alt="Hero & Workflow" width="100%">
30+
<img src="docs/assets/hero.png" alt="Hero & Workflow" width="800" style="max-width: 100%;">
3031

3132
<br/>
3233
</div>
3334

3435
Hyper-Extract is an intelligent, LLM-powered knowledge extraction and evolution framework. It radically simplifies transforming highly unstructured texts into persistent, predictable, and strongly-typed **Knowledge Abstracts**. It effortlessly extracts information into a wide spectrum of formats—ranging from simple **Collections** (Lists/Sets) and **Pydantic Models**, to complex **Knowledge Graphs**, **Hypergraphs**, and even **Spatio-Temporal Graphs**.
3536

37+
## 📑 Table of Contents
38+
39+
- [Core Features](#-core-features)
40+
- [Quick Start](#-quick-start)
41+
- [CLI](#2-the-command-line-way)
42+
- [Python API](#-the-python-api-way)
43+
- [The 8 Auto-Types](#-deep-dive-the-8-auto-types)
44+
- [Architecture](#-architecture-overview)
45+
- [Comparison](#-comparison-with-other-libraries)
46+
- [Documentation](#-related-documentation)
47+
3648
## ✨ Core Features
3749

3850
- 🔷 **8 Auto-Types:** From basic `AutoModel`/`AutoList` to advanced `AutoGraph`, `AutoHypergraph`, and `AutoSpatioTemporalGraph`.
@@ -46,8 +58,16 @@ Hyper-Extract is an intelligent, LLM-powered knowledge extraction and evolution
4658

4759
### 1. Installation
4860

61+
**For CLI Users** (install `he` command globally):
62+
4963
```bash
50-
uv pip install hyper-extract
64+
uv tool install hyperextract
65+
```
66+
67+
**For Python Developers** (use as library):
68+
69+
```bash
70+
uv pip install hyperextract
5171
```
5272

5373
### 2. The Command Line Way
@@ -77,7 +97,7 @@ he show ./output/
7797
```
7898

7999
<details>
80-
<summary><b>🐍 The Python API Way</b></summary>
100+
<summary><b>🐍 The Python API Way</b> (click to expand)</summary>
81101
<br>
82102

83103
### Installation
@@ -117,15 +137,15 @@ from hyperextract import Template
117137
ka = Template.create("general/biography_graph")
118138

119139
# Parse a document
120-
with open("examples/en/tesla.md", "r") as f:
140+
with open("examples/en/tesla.md", "r", encoding="utf-8") as f:
121141
text = f.read()
122142
result = ka.parse(text)
123143

124144
# Visualize the knowledge graph
125145
ka.show(result)
126146

127147
# Incrementally supplement knowledge
128-
with open("examples/en/tesla_question.md", "r") as f:
148+
with open("examples/en/tesla_question.md", "r", encoding="utf-8") as f:
129149
new_text = f.read()
130150
ka.feed(result, new_text)
131151

@@ -137,17 +157,26 @@ ka.show(result)
137157
138158
</details>
139159

160+
<br>
161+
162+
**Installation Comparison:**
163+
164+
| Use Case | Command | Purpose |
165+
|----------|---------|---------|
166+
| CLI Tool | `uv tool install hyperextract` | Install `he` command globally |
167+
| Python Library | `uv pip install hyperextract` | Use in Python code |
168+
140169
## 🧩 Deep Dive: The 8 Auto-Types
141170

142171
Our framework embraces complexity without making you write boilerplate code.
143172

144-
![Knowledge Structures Matrix](docs/assets/autotypes.png)
173+
<img src="docs/assets/autotypes.png" alt="Knowledge Structures Matrix" width="700" style="max-width: 100%;">
145174

146175
### Example: AutoGraph Visualization
147176

148177
Here is the knowledge graph visualization after `AutoGraph` extraction:
149178

150-
![AutoGraph Visualization](docs/assets/en_show.png)
179+
<img src="docs/assets/en_show.png" alt="AutoGraph Visualization" width="600" style="max-width: 100%; border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.1);">
151180

152181
## 🛠️ Architecture Overview
153182

@@ -161,7 +190,7 @@ Hyper-Extract follows a **three-layer architecture**:
161190

162191
Use via **CLI** (`he parse`, `he search`, `he show`...) or **Python API** (`Template.create()`).
163192

164-
![Architecture](docs/assets/arch.png)
193+
<img src="docs/assets/arch.png" alt="Architecture" width="750" style="max-width: 100%;">
165194

166195
### 📚 Related Documentation
167196

README_ZH.md

Lines changed: 42 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515

1616
[📖 English Version](./README.md) · [中文版](./README_ZH.md)
1717

18+
[![PyPI版本](https://img.shields.io/pypi/v/hyperextract)](https://pypi.org/project/hyperextract/)
1819
[![Python版本](https://img.shields.io/badge/python-3.11%2B-blue)](https://python.org)
1920
[![开源协议](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
2021
[![状态](https://img.shields.io/badge/status-active-success)]()
@@ -26,13 +27,24 @@
2627
2728
<br/>
2829

29-
<img src="docs/assets/hero.png" alt="Hero & Workflow" width="100%">
30+
<img src="docs/assets/hero.png" alt="Hero & Workflow" width="800" style="max-width: 100%;">
3031

3132
<br/>
3233
</div>
3334

3435
Hyper-Extract 是一个智能的、由大语言模型(LLM)驱动的知识提取与演进框架。它极大地简化了将杂乱不堪的文本转化为持久化、强类型的**知识摘要(Knowledge Abstracts)**的过程。无论从基础的**集合(Collection/List)和**结构化模型(Model),还是到高阶复杂的**知识图谱(Knowledge Graph)****超图(Hypergraph)**,甚至是**时空图谱(Spatio-Temporal Graph)**,它都能轻松拿捏。
3536

37+
## 📑 目录
38+
39+
- [核心亮点](#-核心亮点)
40+
- [快速上手](#-快速上手)
41+
- [CLI命令行](#2-cli-命令行玩法)
42+
- [Python API](#-python-api-深度集成)
43+
- [8大知识结构](#-8种核心知识结构)
44+
- [系统架构](#-系统架构)
45+
- [对比其他库](#-与其他相关库的对比)
46+
- [文档](#-相关文档)
47+
3648
## ✨ 核心亮点
3749

3850
- 🔷 **8大基础知识结构数据结构(Auto-Types):** 从基础的 `AutoModel`/`AutoList` 到高阶的 `AutoGraph`, `AutoHypergraph`, 以及 `AutoSpatioTemporalGraph`(时空图)。
@@ -44,10 +56,18 @@ Hyper-Extract 是一个智能的、由大语言模型(LLM)驱动的知识提
4456

4557
## ⚡ 快速上手
4658

47-
### 1. 极速安装
59+
### 1. 安装
60+
61+
**CLI 用户**(全局安装 `he` 命令):
4862

4963
```bash
50-
uv pip install hyper-extract
64+
uv tool install hyperextract
65+
```
66+
67+
**Python 开发者**(作为库使用):
68+
69+
```bash
70+
uv pip install hyperextract
5171
```
5272

5373
### 2. CLI 命令行玩法
@@ -77,7 +97,7 @@ he show ./output/
7797
```
7898

7999
<details>
80-
<summary><b>🐍 Python API 深度集成</b></summary>
100+
<summary><b>🐍 Python API 深度集成</b>(点击展开)</summary>
81101
<br>
82102

83103
### 安装
@@ -137,17 +157,26 @@ ka.show(result)
137157
138158
</details>
139159

160+
<br>
161+
162+
**安装方式对比:**
163+
164+
| 使用场景 | 命令 | 说明 |
165+
|----------|------|------|
166+
| CLI 工具 | `uv tool install hyperextract` | 全局安装 `he` 命令 |
167+
| Python 库 | `uv pip install hyperextract` | 在 Python 代码中使用 |
168+
140169
## 🧩 8 种核心知识结构
141170

142171
拒绝样板代码,纯干货聚焦数据本身。
143172

144-
![Knowledge Structures Matrix](docs/assets/autotypes.png)
173+
<img src="docs/assets/autotypes.png" alt="知识结构矩阵" width="700" style="max-width: 100%;">
145174

146175
### 示例:AutoGraph 知识图谱可视化
147176

148177
以下是 `AutoGraph` 类型提取后的知识图谱可视化效果:
149178

150-
![AutoGraph 可视化](docs/assets/zh_show.png)
179+
<img src="docs/assets/zh_show.png" alt="AutoGraph 可视化" width="600" style="max-width: 100%; border-radius: 8px; box-shadow: 0 4px 12px rgba(0,0,0,0.1);">
151180

152181
## 🛠️ 系统架构
153182

@@ -161,7 +190,7 @@ Hyper-Extract 采用**三层架构**:
161190

162191
可通过 **CLI**`he parse``he search``he show`...)或 **Python API**`Template.create()`)使用。
163192

164-
![Architecture](docs/assets/arch.png)
193+
<img src="docs/assets/arch.png" alt="系统架构" width="750" style="max-width: 100%;">
165194

166195
### 📝 相关文档
167196

@@ -244,12 +273,13 @@ display:
244273
| 多语言支持 | ✅ | ❌ | ❌ | ❌ | ✅ |
245274
246275
247-
## 📚 项目参考文档
276+
## 📚 相关文档
248277
249-
- [CLI 命令行指南](./hyperextract/cli/README.md)
250-
- [模板画廊](./hyperextract/templates/)
251-
- [示例代码示例](./examples/)
252-
- [完整架构文档](./docs/)
278+
- [完整文档](https://hyper-extract.github.io/zh/) - 完整文档站点
279+
- [English Documentation](https://hyper-extract.github.io/en/) - English Documentation
280+
- [CLI 指南](https://hyper-extract.github.io/zh/cli/) - 命令行界面
281+
- [模板画廊](https://hyper-extract.github.io/zh/templates/) - 可用模板
282+
- [示例代码](./examples/) - 可运行示例
253283
254284
## 🤝 参与贡献与协议
255285

docs/en/cli/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ The Hyper-Extract CLI (`he`) provides a powerful, easy-to-use interface for know
99
=== "uv (recommended)"
1010

1111
```bash
12-
uv pip install hyper-extract
12+
uv tool install hyperextract
1313
```
1414

15-
=== "pip"
15+
=== "pipx"
1616

1717
```bash
18-
pip install hyper-extract
18+
pipx install hyperextract
1919
```
2020

2121
Verify installation:

docs/en/getting-started/installation.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,62 @@ Hyper-Extract requires **Python 3.11+**.
44

55
---
66

7-
## Install from PyPI
7+
## Install as CLI Tool
8+
9+
If you want to use the `he` command from anywhere:
810

911
=== "uv (recommended)"
1012

1113
```bash
12-
uv pip install hyper-extract
14+
uv tool install hyperextract
1315
```
1416

15-
=== "pip"
17+
=== "pipx"
18+
19+
```bash
20+
pipx install hyperextract
21+
```
22+
23+
---
24+
25+
## Install as Python Library
26+
27+
If you want to use Hyper-Extract in your Python code:
28+
29+
=== "uv (recommended)"
1630

1731
```bash
18-
pip install hyper-extract
32+
uv pip install hyperextract
1933
```
2034

21-
=== "conda"
35+
=== "pip"
2236

2337
```bash
24-
pip install hyper-extract
38+
pip install hyperextract
2539
```
2640

2741
---
2842

2943
## Verify Installation
3044

31-
```bash
32-
he --version
33-
```
45+
=== "CLI"
3446

35-
You should see something like:
47+
```bash
48+
he --version
49+
```
3650

37-
```
38-
Hyper-Extract CLI version 0.1.0
39-
```
51+
You should see something like:
52+
53+
```
54+
Hyper-Extract CLI version 0.1.0
55+
```
56+
57+
=== "Python"
58+
59+
```python
60+
import hyperextract
61+
print(hyperextract.__version__)
62+
```
4063

4164
---
4265

docs/en/getting-started/python-quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ cd my_extraction_project
2222
python -m venv venv
2323
source venv/bin/activate # On Windows: venv\Scripts\activate
2424

25-
# Install hyper-extract
26-
pip install hyper-extract
25+
# Install hyperextract
26+
pip install hyperextract
2727
```
2828

2929
---
@@ -257,7 +257,7 @@ if __name__ == "__main__":
257257
## Troubleshooting
258258
259259
**"No module named 'hyperextract'"**
260-
→ Run `pip install hyper-extract`
260+
→ Run `pip install hyperextract`
261261
262262
**"API key not found"**
263263
→ Check your `.env` file or set `OPENAI_API_KEY` environment variable

docs/en/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
=== "CLI (Terminal)"
1818

1919
```bash
20-
# 1. Install
21-
pip install hyper-extract
20+
# 1. Install CLI tool
21+
uv tool install hyperextract
2222

2323
# 2. Configure API Key
2424
he config init -k YOUR_OPENAI_API_KEY

docs/en/python/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Build knowledge extraction pipelines with the Hyper-Extract Python API.
77
## Installation
88

99
```bash
10-
pip install hyper-extract
10+
pip install hyperextract
1111
```
1212

1313
For development:
1414

1515
```bash
16-
pip install hyper-extract[dev]
16+
pip install hyperextract[dev]
1717
```
1818

1919
---

docs/en/python/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get started with the Hyper-Extract Python SDK in 5 minutes.
1212
## Installation
1313

1414
```bash
15-
pip install hyper-extract
15+
pip install hyperextract
1616
```
1717

1818
## Basic Usage

0 commit comments

Comments
 (0)