From 07d625d83b8082dcec9d31cb442cb742d8f79cea Mon Sep 17 00:00:00 2001 From: dengwenjie <775747758@qq.com> Date: Wed, 29 Oct 2025 17:05:07 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- examples/README.md | 53 ++++++++++++-------------- examples/face-example/README.md | 16 +++++--- examples/ocr-examples/README.md | 44 +++++++++------------ examples/speech-examples/README.md | 37 ++++++++---------- examples/translation-example/README.md | 13 +++++-- examples/vision-example/README.md | 15 ++++++-- 6 files changed, 90 insertions(+), 88 deletions(-) diff --git a/examples/README.md b/examples/README.md index 3309623..3648e33 100644 --- a/examples/README.md +++ b/examples/README.md @@ -6,39 +6,36 @@ ``` src/main/java/smartai/examples/ -├── face/ 人脸相关示例 -│ ├── attribute/ 人脸属性检测模块 -│ │ └── FaceAttributeDetDemo.java 示例：检测性别、年龄等人脸属性 -│ ├── facerec/ 人脸识别模块（1:1、1:N） -│ │ ├── FaceNetDemo.java 示例：使用 FaceNet 算法做人脸识别 -│ │ ├── GpuFaceDemo.java 示例：使用 GPU 加速的人脸识别 -│ │ ├── LightFaceDemo.java 示例：轻量级人脸识别模型（适用于嵌入式场景） -│ │ ├── RetinaFaceDemo.java 示例：使用 RetinaFace 进行人脸检测 -│ │ └── SeetaFace6Demo.java 示例：集成 SeetaFace6 的人脸识别 -│ └── liveness/ 活体检测模块 -│ ├── LivenessDetDemo.java 示例：基于图像进行活体检测 -├── objectdetection/ 目标检测模块 -│ └── ObjectDetection.java 示例：使用目标检测模型识别图像中的目标 -└── ocr/ OCR文字识别模块 -│ ├── OcrDetectionDemo.java 示例：OCR通用文字检测示例 -│ ├── OcrDirectionDetDemo.java 示例：OCR方向检测示例 -│ └── OcrRecognizeDemo.java 示例：OCR通用文字识别示例 -├── nlp/ NLP -│ ├── translate/ 机器翻译 -│ └── TranslationDemo.java 示例：机器翻译 +├── face-example/ 人脸检测、人脸识别等功能示例 +├── vision-example/ 通用视觉检测示例：目标检测、目标分割、图像分类等 +├── ocr-example/ OCR文字识别、车牌识别等功能示例 +├── translate-example/ 机器翻译功能示例 +├── speech-example/ 语音识别、语音合成功能示例 + ``` -## 快速开始 +本项目在 `examples` 文件夹下提供了多个示例工程，用于演示各功能模块的使用方法： -1. 克隆本项目 -2. 导入 IDE（推荐 IntelliJ IDEA） -3. 运行对应 demo 文件即可测试功能（确保模型文件已准备好） +* `face-example`：人脸检测、人脸识别等功能示例 +* `vision-example`：通用视觉检测示例：目标检测、目标分割、图像分类等 +* `ocr-example`：OCR文字识别、车牌识别等功能示例 +* `translate-example`：机器翻译功能示例 +* `speech-example`：语音识别、语音合成功能示例 -## 模型说明 +## 运行方式 + +如果你只想运行某个示例，请按以下方式操作： + +1. 打开 IDEA（或你喜欢的 IDE） +2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如： + + ``` + examples/face-example + ``` +3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。 +4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。 +5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。 -- 本示例项目配合 `smartjavaai` 平台使用，模型加载及使用方式已封装好。 -- 支持 CPU 和 GPU 两种运行模式。 -- 所有模型均可通过 Maven 或本地加载方式接入。 ## 联系与支持 diff --git a/examples/face-example/README.md b/examples/face-example/README.md index cbdc26b..c749e25 100644 --- a/examples/face-example/README.md +++ b/examples/face-example/README.md @@ -83,15 +83,21 @@ src/main/java/smartai/examples/face/ --- -## 🚀 快速开始 -1. 克隆项目到本地： +## 运行方式 -2. 导入项目至 IntelliJ IDEA。 +如果你只想运行某个示例，请按以下方式操作： -3. 根据需要修改模型路径（见各 demo 中注释）。 +1. 打开 IDEA（或你喜欢的 IDE） +2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如： + + ``` + examples/face-example + ``` +3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。 +4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。 +5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。 -4. 运行对应的 JUnit 测试类方法即可体验各项功能。 --- diff --git a/examples/ocr-examples/README.md b/examples/ocr-examples/README.md index 4b395a1..b30c95c 100644 --- a/examples/ocr-examples/README.md +++ b/examples/ocr-examples/README.md @@ -9,11 +9,16 @@ src ├── main │ ├── java │ │ └── smartai/examples/ocr -│ │ ├── OcrDetectionDemo.java # 文本检测示例 -│ │ ├── OcrDirectionDetDemo.java # 文本方向检测示例 -│ │ └── OcrRecognizeDemo.java # 文本识别示例 +│ │ ├── common +│ │ │ ├── OcrDetectionDemo.java # 文本检测示例 +│ │ │ ├── OcrDirectionDetDemo.java # 文本方向检测示例 +│ │ │ └── OcrRecognizeDemo.java # 文本识别示例 +│ │ └── table +│ │ └── TableRecDemo.java # 表格识别示例 +│ │ └── plate +│ │ └── PlateRecDemo.java # 车牌识别示例 │ └── resources -│ ├── logback.xml # 日志配置文件 +│ ├── logback.xml # 日志配置文件 └── test @@ -22,24 +27,6 @@ src --- -## 🧩 功能说明 - -### 1. 文本检测 - [OcrDetectionDemo] - -- **功能**：检测图像中的文本区域，仅返回文本框位置，不识别文字内容。 - - -### 2. 文本方向检测 - [OcrDirectionDetDemo] - -- **功能**：在文本检测基础上，判断文本整体方向（0°, 90°, 180°, 270°）。 - -### 3. 文本识别 - [OcrRecognizeDemo] - -- **功能**：对检测到的文本区域进行文字识别，支持简体中文、繁体中文、英文、日文等。 -- **流程**： - - 文本检测 → 文本识别（或加上方向矫正） - ---- ## ⚙️ 配置要求 @@ -56,13 +43,18 @@ src ## 🚀 快速开始 -1. 克隆项目到本地： +如果你只想运行某个示例，请按以下方式操作： -2. 导入项目至 IntelliJ IDEA。 +1. 打开 IDEA（或你喜欢的 IDE） +2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如： -3. 根据需要修改模型路径（见各 demo 中注释）。 + ``` + examples/ocr-example + ``` +3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。 +4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。 +5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。 -4. 运行对应的 JUnit 测试类方法即可体验各项功能。 --- diff --git a/examples/speech-examples/README.md b/examples/speech-examples/README.md index a747d4b..d5b2d84 100644 --- a/examples/speech-examples/README.md +++ b/examples/speech-examples/README.md @@ -1,11 +1,4 @@ -# OCR文字识别示例 - - -我来为你写一个 `speech-examples` 项目的 README.md 文件。 - -## 🎤 语音识别示例 - -本项目展示了如何使用 SmartJavaAI SDK 进行语音识别，支持 Whisper 和 Vosk 两种语音识别引擎。 +# 语音识别ASR+语音合成TTS示例 ## 📁 项目结构 @@ -13,25 +6,27 @@ src ├── main │ ├── java -│ │ └── smartai/examples/speech/asr -│ │ └── SpeechRecognizeDemo.java # 语音识别示例 -│ └── resources -│ ├── logback.xml # 日志配置文件 -│ ├── speech_zh.mp3 # 中文测试音频 -│ ├── lff_zh.mp3 # 中文测试音频 -│ └── jfk_en.wav # 英文测试音频 -└── test +│ │ └── smartai/examples/speech +│ │ ├── asr +│ │ │ ├── SherpaAsrDemo.java # sherpa-onnx 语音识别ASR 示例 +│ │ │ ├── SpeechRecognizeDemo.java # 其他模型的 语音识别ASR 示例 +│ │ └── tts +│ │ └── TtsDemo.java # tts语音合成示例 ``` ## 🚀 快速开始 -1. 克隆项目到本地： +如果你只想运行某个示例，请按以下方式操作： -2. 导入项目至 IntelliJ IDEA。 +1. 打开 IDEA（或你喜欢的 IDE） +2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如： -3. 根据需要修改模型路径（见各 demo 中注释）。 - -4. 运行对应的 JUnit 测试类方法即可体验各项功能。 + ``` + examples/speech-example + ``` +3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。 +4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。 +5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。 --- diff --git a/examples/translation-example/README.md b/examples/translation-example/README.md index 657a51d..347b699 100644 --- a/examples/translation-example/README.md +++ b/examples/translation-example/README.md @@ -22,13 +22,18 @@ ## 🚀 快速开始 -1. 克隆项目到本地： +如果你只想运行某个示例，请按以下方式操作： -2. 导入项目至 IntelliJ IDEA。 +1. 打开 IDEA（或你喜欢的 IDE） +2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如： -3. 根据需要修改模型路径（见各 demo 中注释）。 + ``` + examples/translation-example + ``` +3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。 +4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。 +5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。 -4. 运行对应的 JUnit 测试类方法即可体验各项功能。 --- diff --git a/examples/vision-example/README.md b/examples/vision-example/README.md index 2a3d7ea..af9cfc4 100644 --- a/examples/vision-example/README.md +++ b/examples/vision-example/README.md @@ -76,13 +76,20 @@ vision-example/ ## 🚀 快速开始 -1. 克隆项目到本地： +## 运行方式 -2. 导入项目至 IntelliJ IDEA。 +如果你只想运行某个示例，请按以下方式操作： -3. 根据需要修改模型路径（见各 demo 中注释）。 +1. 打开 IDEA（或你喜欢的 IDE） +2. 选择 **“Open”**，然后仅导入 `examples` 目录下对应的示例项目，例如： + + ``` + examples/vison-example + ``` +3. IDEA 会自动识别并加载依赖。若首次导入，请等待 Maven 下载依赖完成。 +4. 请从我们提供的 百度网盘 中下载模型及其附带文件，并在示例代码中将模型路径修改为您本地的实际路径。 +5. 可通过查看每个 Java 文件顶部的注释了解对应功能，或参考 README 文件中对各 Java 文件功能的说明，运行相应的测试方法进行体验。 -4. 运行对应的 JUnit 测试类方法即可体验各项功能。 ---