coco1990 commited on
Commit
d305f1e
·
verified ·
1 Parent(s): f1b4581

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -224
README.md CHANGED
@@ -1,224 +1,28 @@
1
- <h1 align="center">Snap-Solver <img src="https://img.shields.io/badge/版本-1.5.1-blue" alt="版本"></h1>
2
-
3
-
4
- <p align="center">
5
- <b>🔍 一键截屏,自动解题 - 线上考试,从未如此简单</b>
6
- </p>
7
-
8
- <p align="center">
9
- <img src="https://img.shields.io/badge/Python-3.x-blue?logo=python" alt="Python">
10
- <img src="https://img.shields.io/badge/Framework-Flask-green?logo=flask" alt="Flask">
11
- <img src="https://img.shields.io/badge/AI-Multi--Model-orange" alt="AI">
12
- <img src="https://img.shields.io/badge/License-Apache%202.0-lightgrey" alt="License">
13
- </p>
14
-
15
-
16
- <p align="center">
17
- <a href="#-核心特性">核心特性</a>
18
- <a href="#-快速开始">快速开始</a> •
19
- <a href="#-新手教程">新手教程</a> •
20
- <a href="#-使用指南">使用指南</a>
21
- <a href="#-技术架构">技术架构</a>
22
- <a href="#-高级配置">高级配置</a>
23
- <a href="#-常见问题">常见问题</a> •
24
- <a href="#-获取帮助">获取帮助</a>
25
- </p>
26
-
27
- <div align="center">
28
- <a href="https://github.com/Zippland/Snap-Solver/releases">
29
- <img src="https://img.shields.io/badge/⚡%20快速开始-下载最新版本-0366D6?style=for-the-badge&logo=github&logoColor=white" alt="获取Release" width="240" />
30
- </a>
31
- &nbsp;&nbsp;&nbsp;&nbsp;
32
- <a href="docs/beginner-tutorial.md">
33
- <img src="https://img.shields.io/badge/📘%20零基础入门-阅读新手教程-FF9800?style=for-the-badge&logo=bookstack&logoColor=white" alt="阅读新手教程" width="240" />
34
- </a>
35
- &nbsp;&nbsp;&nbsp;&nbsp;
36
- <a href="mailto:zylanjian@outlook.com">
37
- <img src="https://img.shields.io/badge/📞%20代部署支持-联系我们-28a745?style=for-the-badge&logo=mail.ru&logoColor=white" alt="联系我们" width="220" />
38
- </a>
39
- </div>
40
- <!-- <p align="center">
41
- <img src="pic.jpg" alt="Snap-Solver 截图" width="300" />
42
- </p> -->
43
-
44
- ## 💫 项目简介
45
-
46
- **Snap-Solver** 是一个革命性的AI笔试测评工具,专为学生、考生和自学者设计。只需**按下快捷键**,即可自动截取屏幕上的任何题目,通过AI进行分析并提供详细解答。
47
-
48
- 无论是复杂的数学公式、物理难题、编程问题,还是其他学科的挑战,Snap-Solver都能提供清晰、准确、有条理的解决方案,帮助您更好地理解和掌握知识点。
49
-
50
- ## 📚 新手教程
51
-
52
- 第一次使用?按照我们的 [《新手教程》](docs/beginner-tutorial.md) 完成环境准备、模型配置和首次解题演练,全程图文指引,几分钟即可上手。
53
-
54
- ## 🔧 技术架构
55
-
56
- ```mermaid
57
- graph TD
58
- A[用户界面] --> B[Flask Web服务]
59
- B --> C{API路由}
60
- C --> D[截图服务]
61
- C --> E[OCR识别]
62
- C --> F[AI分析]
63
- E --> |Mathpix API| G[文本提取]
64
- F --> |模型选择| H1[OpenAI]
65
- F --> |模型选择| H2[Anthropic]
66
- F --> |模型选择| H3[DeepSeek]
67
- F --> |模型选择| H4[Alibaba]
68
- F --> |模型选择| H5[Google]
69
- F --> |模型选择| H6[Doubao]
70
- D --> I[Socket.IO实时通信]
71
- I --> A
72
- ```
73
-
74
- ## ✨ 核心特性
75
-
76
- <table>
77
- <tr>
78
- <td width="50%">
79
- <h3>📱 跨设备协同</h3>
80
- <ul>
81
- <li><b>一键截图</b>:按下快捷键,即可在移动设备上查看和分析电脑屏幕</li>
82
- <li><b>局域网共享</b>:一处部署,多设备访问,提升学习效率</li>
83
- </ul>
84
- </td>
85
- <td width="50%">
86
- <h3>🧠 多模型AI支持</h3>
87
- <ul>
88
- <li><b>GPT 家族</b>:OpenAI强大的推理能力</li>
89
- <li><b>Claude 家族</b>:Anthropic的高级理解与解释</li>
90
- <li><b>DeepSeek 家族</b>:专为中文场景优化的模型</li>
91
- <li><b>QVQ 和 Qwen 家族</b>:以视觉推理闻名的国产AI</li>
92
- <li><b>Gemini 家族</b>:智商130的非推理AI</li>
93
- </ul>
94
- </td>
95
- </tr>
96
- <tr>
97
- <td>
98
- <h3>🔍 精准识别</h3>
99
- <ul>
100
- <li><b>OCR文字识别</b>:准确捕捉图片中的文本</li>
101
- <li><b>数学公式支持</b>:通过Mathpix精确识别复杂数学符号</li>
102
- </ul>
103
- </td>
104
- <td>
105
- <h3>🌐 全球无障碍</h3>
106
- <ul>
107
- <li><b>VPN代理支持</b>:自定义代理设置,解决网络访问限制</li>
108
- <li><b>多语言响应</b>:支持定制AI回复语言</li>
109
- </ul>
110
- </td>
111
- </tr>
112
- <tr>
113
- <td>
114
- <h3>💻 全平台兼容</h3>
115
- <ul>
116
- <li><b>桌面支持</b>:Windows、MacOS、Linux</li>
117
- <li><b>移动访问</b>:手机、平板通过浏览器直接使用</li>
118
- </ul>
119
- </td>
120
- <td>
121
- <h3>⚙️ 高度可定制</h3>
122
- <ul>
123
- <li><b>思考深度控制</b>:调整AI的分析深度</li>
124
- <li><b>自定义提示词</b>:针对特定学科优化提示</li>
125
- </ul>
126
- </td>
127
- </tr>
128
- </table>
129
-
130
- ## 🚀 快速开始
131
-
132
- ### 📋 前置要求
133
-
134
- - Python 3.x
135
- - 至少以下一个API Key:
136
- - OpenAI API Key
137
- - Anthropic API Key (推荐✅)
138
- - DeepSeek API Key
139
- - Alibaba API Key (国内用户首选)
140
- - Google API Key
141
- - Mathpix API Key (推荐OCR识别✅)
142
-
143
- ### 📥 开始使用
144
-
145
- ```bash
146
- # 启动应用
147
- python app.py
148
- ```
149
-
150
- ### 📱 访问方式
151
-
152
- - **本机访问**:打开浏览器,访问 http://localhost:5000
153
- - **局域网设备访问**:在同一网络的任何设备上访问 `http://[电脑IP]:5000`
154
-
155
- ### 🎯 使用场景示例
156
-
157
- - **课后习题**:截取教材或作业中的难题,获取步骤详解
158
- - **编程调试**:截取代码错误信息,获取修复建议
159
- - **考试复习**:分析错题并理解解题思路
160
- - **文献研究**:截取复杂论文段落,获取简化解释
161
-
162
- ### 🧩 组件详情
163
-
164
- - **前端**:响应式HTML/CSS/JS界面,支持移动设备
165
- - **后端**:Flask + SocketIO,提供RESTful API和WebSocket
166
- - **AI接口**:多模型支持,统一接口标准
167
- - **图像处理**:高效的截图和裁剪功能
168
-
169
- ## ⚙️ 高级可调参数
170
-
171
- - **温度**:调整回答的创造性与确定性(0.1-1.0)
172
- - **最大输出Token**:控制回答长度
173
- - **推理深度**:标准模式(快速)或深度思考(详细)
174
- - **思考预算占比**:平衡思考过程与最终答案的详细程度
175
- - **系统提示词**:自定义AI的基础行为与专业领域
176
-
177
- ## ❓ 常见问题
178
-
179
- <details>
180
- <summary><b>如何获得最佳识别效果?</b></summary>
181
- <p>
182
- 确保截图清晰,包含完整题目和必要上下文。对于数学公式,建议使用Mathpix OCR以获得更准确的识别结果。
183
- </p>
184
- </details>
185
-
186
- <details>
187
- <summary><b>无法连接到服务怎么办?</b></summary>
188
- <p>
189
- 1. 检查防火墙设置是否允许5000端口<br>
190
- 2. 确认设备在同一局域网内<br>
191
- 3. 尝试重启应用程序<br>
192
- 4. 查看控制台日志获取错误信息
193
- </p>
194
- </details>
195
-
196
- <details>
197
- <summary><b>API调用失败的原因?</b></summary>
198
- <p>
199
- 1. API密钥可能无效或余额不足<br>
200
- 2. 网络连接问题,特别是国际API<br>
201
- 3. 代理设置不正确<br>
202
- 4. API服务可能临时不可用
203
- </p>
204
- </details>
205
-
206
- <details>
207
- <summary><b>如何优化AI回答质量?</b></summary>
208
- <p>
209
- 1. 调整系统提示词,添加特定学科的指导<br>
210
- 2. 根据问题复杂度选择合适的模型<br>
211
- 3. 对于复杂题目,使用"深度思考"模式<br>
212
- 4. 确保截取的题目包含完整信息
213
- </p>
214
- </details>
215
-
216
- ## 🤝 获取帮助
217
-
218
- - **代部署服务**:如果您不擅长编程,需要代部署服务,请联系 [zylanjian@outlook.com](mailto:zylanjian@outlook.com)
219
- - **问题报告**:在GitHub仓库提交Issue
220
- - **功能建议**:欢迎通过Issue或邮件提供改进建议
221
-
222
- ## 📜 开源协议
223
-
224
- 本项目采用 [Apache 2.0](LICENSE) 协议。
 
1
+ ---
2
+ title: Snap Solver
3
+ emoji: 🌍
4
+ colorFrom: yellow
5
+ colorTo: indigo
6
+ sdk: docker
7
+ # 【!!!关键修正!!!】 必须添加 app_port 字段
8
+ # Hugging Face Spaces 默认将 PORT 环境变量设置为 7860
9
+ app_port: 7860
10
+ pinned: false
11
+ license: mit
12
+ ---
13
+
14
+ # 🚀 Snap-Solver 部署成功
15
+
16
+ 这是一个基于 **Flask + SocketIO** 的 AI 测评工具。
17
+ 该服务通过 Docker 容器部署在 Hugging Face Spaces 上。
18
+
19
+ **核心技术栈:**
20
+ * **后端:** Flask + SocketIO
21
+ * **依赖:** 见 requirements.txt
22
+ * **AI 接口:** 多模型调用(如 OpenAI, Google Generative AI 等)
23
+
24
+ **使用指南:**
25
+ 请通过浏览器访问本 Space 域名,上传截图进行解题。
26
+
27
+ **注意:**
28
+ 此云端服务不具备本地截图和剪贴板功能,请在客户端(手机/电脑)完成截图后上传。