fvandaalen/carrier

carrier模型暴露Docker镜像文档

镜像概述

本Docker镜像仓库用于暴露模型供carrier系统使用，提供Web服务接口实现特定风险评估功能。当前版本包含贝叶斯网络模型，后续将支持Cox比例风险模型、神经网络和贝叶斯集成模型。

核心功能与特性

可用模型

• 贝叶斯网络：用于心血管疾病(CVD)风险评估

开发中模型

• Cox比例风险模型
• 神经网络
• 贝叶斯集成模型

主要特性

• 提供RESTful Web服务接口
• 支持基线风险评估和降低风险评估
• 具备错误处理机制，返回明确的错误信息

系统要求

推荐配置

• 处理器：Intel(R) Core(TM) i7-***H CPU @ 2.60GHz 2.59 GHz（或同等性能）
• 内存：16GB RAM
• 已安装Docker环境

镜像大小

• 当前仅包含贝叶斯网络：385MB

使用方法

贝叶斯网络模型部署

镜像获取与运行

Docker镜像位于Docker Hub：fvandaalen/carrier

运行命令：

bash
docker run -p 8080:8080 fvandaalen/carrier:modelexposer<version>

注意：将<version>替换为实际版本号

提供的Web服务接口

容器启动后可通过以下接口访问：

• http://localhost:8080/estimateBaseLineRisk：估算个体的CVD基线风险
• http://localhost:8080/estimateReducedRisk：估算不同干预措施下的CVD风险变化

注：当前镜像中的模型为占位模型，正在开发完善中

接口使用说明

estimateBaseLineRisk接口

功能：估算给定个体的CVD基线风险

请求参数：

• input：个体属性（如吸烟状态、性别等）
• modelType：模型类型（可选，默认为贝叶斯网络）

请求示例：

json
{
  "input" : {
    "current_smoker" : "yes"
  },
  "modelType" : "bayesian"
}

响应示例：

json
{
  "probabilities": {
    "CVD": 0.07865005183850245
  }
}

estimateReducedRisk接口

功能：估算不同干预措施下的CVD风险变化，提供基线风险和各干预后的风险对比

请求参数：

• input：个体基线属性
• changes：干预措施列表（每个干预改变一个属性）
• modelType：模型类型（可选，默认为贝叶斯网络）

请求示例：

json
{
  "input" : {
    "gender" : "male"
  },"changes":[{
  	"current_smoker":"yes"
  },{
  	"BMI":"20"
  	}],
	"modelType" : "bayesian"
}

响应示例：

json
{
   "changes":    [
            {
         "probabilities": {"CVD": 0.0865},
         "changed": {"current_smoker": "yes"}
      },
            {
         "probabilities": {"CVD": 0.0865},
         "changed": {"BMI": "20"}
      }
   ],
   "baseline": {"probabilities": {"CVD": 0.08650000000000001}}
}

错误处理

系统会返回包含错误信息的JSON对象，格式如下：

json
{"message":"error"}

常见错误类型

1. UnknownAttribute Exception

   • 消息格式："Unknown attribute 'x'"
   • 说明：请求中包含未知的属性名

2. UnknownState Exception

   • 消息格式："Unknown state 'x' for attribute 'y', expected valid states: 'a', 'b', 'c'"
   • 说明：属性值不符合预期的有效状态

使用示例

estimateBaseLineRisk接口示例

示例1：

• 输入：

json
{
  "input" : {
    "age" : "1"
  }
}

• 输出：

json
{"probabilities": {"CVD": 0.08650000000000001}}

示例2：

• 输入：

json
{
  "input" : {
    "current_smoker" : "yes"
  }
}

• 输出：

json
{"probabilities": {"CVD": 0.08650000000000002}}

示例3：

• 输入：

json
{
  "input" : {
    "current_smoker" : "yes",
    "gender" : "male"
  }
}

• 输出：

json
{"probabilities": {"CVD": 0.0865}}

示例4（错误）：

• 输入：

json
{
  "input" : {
    "current_smoker" : "nonsense",
    "gender" : "male"
  }
}

• 输出：

json
{"message": "Unknown state 'nonsense' for attribute 'current_smoker', expected valid states: 'no', 'yes'"}

示例5（错误）：

• 输入：

json
{
  "input" : {
    "nonsense" : "nonsense",
    "gender" : "male"
  }
}

• 输出：

json
{"message": "Unknown attribute 'nonsense'"}

estimateReducedRisk接口示例

示例1：

• 输入：

json
{
  "input" : {
    "gender" : "male"
  },"changes":[{
  	"current_smoker":"yes"
  },{
  	"BMI":"20"
  	}],
	"modelType" : "bayesian"
}

• 输出：

json
{
   "changes":    [
            {
         "probabilities": {"CVD": 0.0865},
         "changed": {"current_smoker": "yes"}
      },
            {
         "probabilities": {"CVD": 0.0865},
         "changed": {"BMI": "20"}
      }
   ],
   "baseline": {"probabilities": {"CVD": 0.08650000000000001}}
}

示例2：

• 输入：

json
{
  "input" : {
    "gender" : "male"
  },"changes":{
  	"current_smoker":"yes",
  	"gout":"yes"
  },
  	"modelType" : "bayesian"
}

• 输出：

json
{
   "changes":    {
      "probabilities": {"CVD": 0.083},
      "changed":       {
         "current_smoker": "yes",
         "gout": "yes"
      }
   },
   "baseline": {"probabilities": {"CVD": 0.08650000000000001}}
}