openmed

环境要求

• Python 3.10 及以上（README 标注 Python 3.10+）
• pip 可用的 Python 环境（用于 pip install openmed[hf]）
• 可选：Docker（如需用容器方式运行）
• 首次使用需联网下载模型产物，之后本地推理

安装与启动步骤

1. 1安装 openmed 包

   用 pip 安装带 Hugging Face 运行时的 openmed，支持 Linux、macOS、Windows 的 CPU 或 CUDA 环境。

   pip install --upgrade "openmed[hf]"

   复制

2. 2启动本地 REST 服务

   用 uvicorn 启动 openmed.service.app，监听 0.0.0.0:8080，并设置模型空闲 10 分钟后自动释放。

   OPENMED_SERVICE_KEEP_ALIVE=10m uvicorn openmed.service.app:app --host 0.0.0.0 --port 8080

   复制

3. 3调用 PII 提取接口

   POST /pii/extract 传入文本和语言代码，返回实体文本、标签、置信度与起止位置。

   curl -X POST http://127.0.0.1:8080/pii/extract -H "Content-Type: application/json" -d '{"text":"Paciente: Maria Garcia, DNI: 12345678Z","lang":"es"}'

   复制

4. 4Docker 方式运行

   在项目根目录构建镜像后运行容器，映射 8080 端口并指定生产配置档。

   docker build -t openmed:local .
   docker run --rm -p 8080:8080 -e OPENMED_PROFILE=prod openmed:local

   复制

5. 5卸载模型释放内存

   服务提供 GET /models/loaded 与 POST /models/unload，可在空闲时释放已加载的模型、分词器和管道。

   curl -X POST http://127.0.0.1:8080/models/unload -H "Content-Type: application/json" -d '{"all":true}'

   复制

关键配置

如何确认成功

启动日志出现 INFO: Uvicorn running on http://0.0.0.0:8080，且 /pii/extract 返回含 entities 的 JSON。

常见问题

注意事项

• README 明确提示：模型下载、远程提供方适配器、开启遥测的路径和用户自定义集成可能使用网络，须自行审阅各模型与数据集的使用条款。
• 生产环境建议使用 API-key/JWT 认证、no-PHI 日志等 v1.8 服务能力，并通过 /livez、/readyz 做健康检查。
• Docker 示例把 8080 端口映射到宿主机，部署到公网前请确认访问控制与限流配置。
• Android 集成需在 settings.gradle.kts 中额外添加 JitPack 仓库并限定 includeGroup("com.github.maziyarpanahi")。