Bladeren bron

docs(README): 添加Streamlit热更新说明及使用方式

zhch158_admin 2 weken geleden
bovenliggende
commit
633bf31226
1 gewijzigde bestanden met toevoegingen van 46 en 4 verwijderingen
  1. 46 4
      ocr_validator/README.md

+ 46 - 4
ocr_validator/README.md

@@ -217,11 +217,53 @@ streamlit run streamlit_ocr_validator.py
 2. 在 `ocr_validator_utils.py` 中添加数据解析函数
 3. 更新 `config/global.yaml` 添加数据源
 
-## 📄 许可证
+---
 
-[根据项目许可证填写]
+# Streamlit 热更新:
 
-## 🤝 贡献
+## 方式 1: 启动参数(最简单)
 
-欢迎提交 Issue 和 Pull Request!
+在启动命令中添加参数:
 
+```bash
+streamlit run streamlit_ocr_validator.py --server.runOnSave true
+```
+
+## 方式 2: 配置文件(推荐)
+
+创建 Streamlit 配置文件: 
+
+已创建 [](file:///Users/zhch158/workspace/repository.git/ocr_platform/ocr_validator/.streamlit/config.toml)
+
+## 方式 3: 更新 VS Code 调试配置 
+
+读取 [](file:///Users/zhch158/workspace/repository.git/ocr_platform/.vscode/launch.json#18-18),行 18 到 40
+
+Using "替换文件中的字符串"
+
+
+```
+
+```
+## 使用说明
+
+### 热更新工作原理
+
+1. **自动检测**:Streamlit 监控 `.py` 文件的变化
+2. **提示重新运行**:检测到变化后会显示 "Source file changed" 提示
+3. **手动/自动重新运行**:
+   - 手动:点击 "Rerun" 按钮
+   - 自动:配置 `runOnSave=true` 后自动重新运行
+
+### 快速测试
+
+修改 streamlit_ocr_validator.py 中的任何内容并保存,Streamlit 会:
+- ✅ 自动检测到文件变化
+- ✅ 立即重新加载应用
+- ✅ 保持当前页面状态(如果使用了 `st.session_state`)
+
+### 注意事项
+
+1. **监控范围**:只监控 Python 文件(`.py`),不监控数据文件
+2. **状态保持**:使用 `st.session_state` 保存状态可以在热更新后保留数据
+3. **性能影响**:如果项目很大,热更新可能需要几秒钟