Skip to content

Commit 07d625d

Browse files
geekwenjiegeekwenjie
committed
更新readme
1 parent d834008 commit 07d625d

File tree

6 files changed

+90
-88
lines changed

6 files changed

+90
-88
lines changed

‎examples/README.md‎

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,36 @@
66

77
```
88
src/main/java/smartai/examples/
9-
├── face/ 人脸相关示例
10-
│ ├── attribute/ 人脸属性检测模块
11-
│ │ └── FaceAttributeDetDemo.java 示例：检测性别、年龄等人脸属性
12-
│ ├── facerec/ 人脸识别模块（1:1、1:N）
13-
│ │ ├── FaceNetDemo.java 示例：使用 FaceNet 算法做人脸识别
14-
│ │ ├── GpuFaceDemo.java 示例：使用 GPU 加速的人脸识别
15-
│ │ ├── LightFaceDemo.java 示例：轻量级人脸识别模型（适用于嵌入式场景）
16-
│ │ ├── RetinaFaceDemo.java 示例：使用 RetinaFace 进行人脸检测
17-
│ │ └── SeetaFace6Demo.java 示例：集成 SeetaFace6 的人脸识别
18-
│ └── liveness/ 活体检测模块
19-
│ ├── LivenessDetDemo.java 示例：基于图像进行活体检测
20-
├── objectdetection/ 目标检测模块
21-
│ └── ObjectDetection.java 示例：使用目标检测模型识别图像中的目标
22-
└── ocr/ OCR文字识别模块
23-
│ ├── OcrDetectionDemo.java 示例：OCR通用文字检测示例
24-
│ ├── OcrDirectionDetDemo.java 示例：OCR方向检测示例
25-
│ └── OcrRecognizeDemo.java 示例：OCR通用文字识别示例
26-
├── nlp/ NLP
27-
│ ├── translate/ 机器翻译
28-
│ └── TranslationDemo.java 示例：机器翻译
9+
├── face-example/ 人脸检测、人脸识别等功能示例
10+
├── vision-example/ 通用视觉检测示例：目标检测、目标分割、图像分类等
11+
├── ocr-example/ OCR文字识别、车牌识别等功能示例
12+
├── translate-example/ 机器翻译功能示例
13+
├── speech-example/ 语音识别、语音合成功能示例
14+
2915
```
3016

31-
## 快速开始
17+
本项目在 `examples` 文件夹下提供了多个示例工程，用于演示各功能模块的使用方法：
18+
19+
* `face-example`：人脸检测、人脸识别等功能示例
20+
* `vision-example`：通用视觉检测示例：目标检测、目标分割、图像分类等
21+
* `ocr-example`：OCR文字识别、车牌识别等功能示例
22+
* `translate-example`：机器翻译功能示例
23+
* `speech-example`：语音识别、语音合成功能示例
24+
25+
## 运行方式
26+
27+
如果你只想运行某个示例，请按以下方式操作：
3228

33-
1. 克隆本项目
34-
2. 导入 IDE（推荐 IntelliJ IDEA）
35-
3. 运行对应 demo 文件即可测试功能（确保模型文件已准备好）
29+
1. 打开 IDEA（或你喜欢的 IDE）
30+
2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如：
3631

37-
## 模型说明
32+
```
33+
examples/face-example
34+
```
35+
3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。
36+
4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。
37+
5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。
3838

39-
- 本示例项目配合 `smartjavaai` 平台使用，模型加载及使用方式已封装好。
40-
- 支持 CPU 和 GPU 两种运行模式。
41-
- 所有模型均可通过 Maven 或本地加载方式接入。
4239

4340
## 联系与支持
4441

‎examples/face-example/README.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,21 @@ src/main/java/smartai/examples/face/
8383

8484
---
8585

86-
## 🚀 快速开始
8786

88-
1. 克隆项目到本地：
87+
## 运行方式
8988

90-
2. 导入项目至 IntelliJ IDEA。
89+
如果你只想运行某个示例，请按以下方式操作：
9190

92-
3. 根据需要修改模型路径（见各 demo 中注释）。
91+
1. 打开 IDEA（或你喜欢的 IDE）
92+
2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如：
93+
94+
```
95+
examples/face-example
96+
```
97+
3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。
98+
4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。
99+
5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。
93100

94-
4. 运行对应的 JUnit 测试类方法即可体验各项功能。
95101

96102
---
97103

‎examples/ocr-examples/README.md‎

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,16 @@ src
99
├── main
1010
│ ├── java
1111
│ │ └── smartai/examples/ocr
12-
│ │ ├── OcrDetectionDemo.java # 文本检测示例
13-
│ │ ├── OcrDirectionDetDemo.java # 文本方向检测示例
14-
│ │ └── OcrRecognizeDemo.java # 文本识别示例
12+
│ │ ├── common
13+
│ │ │ ├── OcrDetectionDemo.java # 文本检测示例
14+
│ │ │ ├── OcrDirectionDetDemo.java # 文本方向检测示例
15+
│ │ │ └── OcrRecognizeDemo.java # 文本识别示例
16+
│ │ └── table
17+
│ │ └── TableRecDemo.java # 表格识别示例
18+
│ │ └── plate
19+
│ │ └── PlateRecDemo.java # 车牌识别示例
1520
│ └── resources
16-
│ ├── logback.xml # 日志配置文件
21+
│ ├── logback.xml # 日志配置文件
1722
└── test
1823
1924
@@ -22,24 +27,6 @@ src
2227

2328
---
2429

25-
## 🧩 功能说明
26-
27-
### 1. 文本检测 - [OcrDetectionDemo]
28-
29-
- **功能**：检测图像中的文本区域，仅返回文本框位置，不识别文字内容。
30-
31-
32-
### 2. 文本方向检测 - [OcrDirectionDetDemo]
33-
34-
- **功能**：在文本检测基础上，判断文本整体方向（0°, 90°, 180°, 270°）。
35-
36-
### 3. 文本识别 - [OcrRecognizeDemo]
37-
38-
- **功能**：对检测到的文本区域进行文字识别，支持简体中文、繁体中文、英文、日文等。
39-
- **流程**：
40-
- 文本检测 → 文本识别（或加上方向矫正）
41-
42-
---
4330

4431

4532
## ⚙️ 配置要求
@@ -56,13 +43,18 @@ src
5643

5744
## 🚀 快速开始
5845

59-
1. 克隆项目到本地：
46+
如果你只想运行某个示例，请按以下方式操作：
6047

61-
2. 导入项目至 IntelliJ IDEA。
48+
1. 打开 IDEA（或你喜欢的 IDE）
49+
2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如：
6250

63-
3. 根据需要修改模型路径（见各 demo 中注释）。
51+
```
52+
examples/ocr-example
53+
```
54+
3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。
55+
4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。
56+
5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。
6457

65-
4. 运行对应的 JUnit 测试类方法即可体验各项功能。
6658

6759
---
6860

‎examples/speech-examples/README.md‎

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,32 @@
1-
# OCR文字识别示例
2-
3-
4-
我来为你写一个 `speech-examples` 项目的 README.md 文件。
5-
6-
## 🎤 语音识别示例
7-
8-
本项目展示了如何使用 SmartJavaAI SDK 进行语音识别，支持 Whisper 和 Vosk 两种语音识别引擎。
1+
# 语音识别ASR+语音合成TTS示例
92

103
## 📁 项目结构
114

125
```
136
src
147
├── main
158
│ ├── java
16-
│ │ └── smartai/examples/speech/asr
17-
│ │ └── SpeechRecognizeDemo.java # 语音识别示例
18-
│ └── resources
19-
│ ├── logback.xml # 日志配置文件
20-
│ ├── speech_zh.mp3 # 中文测试音频
21-
│ ├── lff_zh.mp3 # 中文测试音频
22-
│ └── jfk_en.wav # 英文测试音频
23-
└── test
9+
│ │ └── smartai/examples/speech
10+
│ │ ├── asr
11+
│ │ │ ├── SherpaAsrDemo.java # sherpa-onnx 语音识别ASR 示例
12+
│ │ │ ├── SpeechRecognizeDemo.java # 其他模型的 语音识别ASR 示例
13+
│ │ └── tts
14+
│ │ └── TtsDemo.java # tts语音合成示例
2415
```
2516

2617
## 🚀 快速开始
2718

28-
1. 克隆项目到本地：
29-
30-
2. 导入项目至 IntelliJ IDEA。
19+
如果你只想运行某个示例，请按以下方式操作：
3120

32-
3. 根据需要修改模型路径（见各 demo 中注释）。
21+
1. 打开 IDEA（或你喜欢的 IDE）
22+
2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如：
3323

34-
4. 运行对应的 JUnit 测试类方法即可体验各项功能。
24+
```
25+
examples/speech-example
26+
```
27+
3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。
28+
4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。
29+
5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。
3530

3631
---
3732

‎examples/translation-example/README.md‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,18 @@
2222

2323
## 🚀 快速开始
2424

25-
1. 克隆项目到本地：
25+
如果你只想运行某个示例，请按以下方式操作：
2626

27-
2. 导入项目至 IntelliJ IDEA。
27+
1. 打开 IDEA（或你喜欢的 IDE）
28+
2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如：
2829

29-
3. 根据需要修改模型路径（见各 demo 中注释）。
30+
```
31+
examples/translation-example
32+
```
33+
3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。
34+
4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。
35+
5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。
3036

31-
4. 运行对应的 JUnit 测试类方法即可体验各项功能。
3237

3338
---
3439

‎examples/vision-example/README.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,20 @@ vision-example/
7676

7777
## 🚀 快速开始
7878

79-
1. 克隆项目到本地：
79+
## 运行方式
8080

81-
2. 导入项目至 IntelliJ IDEA。
81+
如果你只想运行某个示例，请按以下方式操作：
8282

83-
3. 根据需要修改模型路径（见各 demo 中注释）。
83+
1. 打开 IDEA（或你喜欢的 IDE）
84+
2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如：
85+
86+
```
87+
examples/vison-example
88+
```
89+
3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。
90+
4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。
91+
5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。
8492

85-
4. 运行对应的 JUnit 测试类方法即可体验各项功能。
8693

8794
---
8895

0 commit comments

Comments
 (0)