欢迎来到 PyHealth！

.. note::

此 README 可能已过时。 如需最新文档、教程和 API 参考，请访问我们的官方文档网站：pyhealth.readthedocs.io <https://pyhealth.readthedocs.io/en/latest/>_。

.. important::

• 加入我们的 PyHealth Discord 社区！ 我们正在积极寻找贡献者，并希望更好地了解我们的用户！ 点击此处加入 Discord <https://discord.gg/mpb835EHaX>_
• 注册我们的邮件列表！ 我们会通过邮件通知您即将发生的任何重要 PyHealth 更新！ 点击此处订阅 <https://docs.google.com/forms/d/e/1FAIpQLSfpJB5tdkI7BccTCReoszV9cyyX2rF99SgznzwlOepi5v-xLw/viewform?usp=header>_

.. image:: https://img.shields.io/readthedocs/pyhealth?logo=readthedocs&label=docs&version=latest :target: https://pyhealth.readthedocs.io/en/latest/ :alt: 文档

.. image:: https://img.shields.io/badge/Discord-Join-5865F2?logo=discord&logoColor=white :target: https://discord.gg/mpb835EHaX :alt: Discord

.. image:: https://img.shields.io/badge/Mailing%20List-Subscribe-blue?logo=gmail&logoColor=white :target: https://docs.google.com/forms/d/e/1FAIpQLSfpJB5tdkI7BccTCReoszV9cyyX2rF99SgznzwlOepi5v-xLw/viewform?usp=header :alt: 邮件列表

.. image:: https://img.shields.io/pypi/v/pyhealth.svg?color=brightgreen :target: https://pypi.org/project/pyhealth/ :alt: PyPI 版本

.. image:: https://img.shields.io/github/stars/sunlabuiuc/pyhealth.svg :target: https://github.com/sunlabuiuc/pyhealth/stargazers :alt: GitHub 星标

.. image:: https://img.shields.io/github/forks/sunlabuiuc/pyhealth.svg?color=blue :target: https://github.com/sunlabuiuc/pyhealth/network :alt: GitHub 分支

.. image:: https://static.pepy.tech/badge/pyhealth :target: https://pepy.tech/project/pyhealth :alt: 下载量

.. image:: https://img.shields.io/badge/Tutorials-Google%20Colab-red :target: https://pyhealth.readthedocs.io/en/latest/tutorials.html :alt: 教程

.. image:: https://img.shields.io/badge/YouTube-16%20Videos-red :target: https://www.youtube.com/playlist?list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV :alt: YouTube

.. image:: https://github.com/sunlabuiuc/PyHealth/workflows/CI/badge.svg :target: https://github.com/sunlabuiuc/PyHealth/actions :alt: CI 状态

引用 PyHealth :handshake:

PyHealth 2.0 (2026):

Wu, John, Yongda Fan, Zhenbang Wu, Paul Landes, Eric Schrock, Sayeed Sajjad Razin, Arjun Chatterjee, Naveen Baskaran, Joshua Steier, Andrea Fitzpatrick, Bilal Arif, Rian Atri, Jathurshan Pradeepkumar, Siddhartha Laghuvarapu, Junyi Gao, Adam R. Cross, and Jimeng Sun. 2026. "PyHealth 2.0: A Comprehensive Open-Source Toolkit for Accessible and Reproducible Clinical Deep Learning." arXiv preprint arXiv:2601.16414.

.. code-block:: bibtex

@misc{wu2026pyhealth20comprehensiveopensource,
    title={PyHealth 2.0: A Comprehensive Open-Source Toolkit for Accessible and Reproducible Clinical Deep Learning}, 
    author={John Wu and Yongda Fan and Zhenbang Wu and Paul Landes and Eric Schrock and Sayeed Sajjad Razin and Arjun Chatterjee and Naveen Baskaran and Joshua Steier and Andrea Fitzpatrick and Bilal Arif and Rian Atri and Jathurshan Pradeepkumar and Siddhartha Laghuvarapu and Junyi Gao and Adam R. Cross and Jimeng Sun},
    year={2026},
    eprint={2601.16414},
    archivePrefix={arXiv},
    primaryClass={cs.LG},
    url={https://arxiv.org/abs/2601.16414}
}

PyHealth 1.0 (2023):

Yang, Chaoqi, Zhenbang Wu, Patrick Jiang, Zhen Lin, Junyi Gao, Benjamin P. Danek, and Jimeng Sun. 2023. "PyHealth: A Deep Learning Toolkit for Healthcare Applications." In Proceedings of the 29th ACM SIGKDD Conference on Knowledge Discovery and Data Mining, 5788–89. KDD '23. New York, NY, USA: Association for Computing Machinery.

.. code-block:: bibtex

@inproceedings{pyhealth2023yang,
    author = {Yang, Chaoqi and Wu, Zhenbang and Jiang, Patrick and Lin, Zhen and Gao, Junyi and Danek, Benjamin and Sun, Jimeng},
    title = {{PyHealth}: A Deep Learning Toolkit for Healthcare Predictive Modeling},
    url = {https://github.com/sunlabuiuc/PyHealth},
    booktitle = {Proceedings of the 27th ACM SIGKDD International Conference on Knowledge Discovery and Data Mining (KDD) 2023},
    year = {2023}
}

---

PyHealth 是一个全面的深度学习工具包，用于支持临床预测建模，专为 机器学习研究人员和医疗从业者 设计。我们可以让您的 医疗 AI 应用程序 更容易开发、测试和部署——更加灵活且可定制。 [教程] <https://pyhealth.readthedocs.io/>_

主要特性

• 针对医疗 ML 的模块化五阶段流水线
• 以医疗为中心：医学编码和临床数据集（MIMIC、eICU、OMOP）
• 33+ 种预构建模型以及生产就绪的训练器和指标
• 支持 10+ 种医疗任务和数据集
• 快速（比 pandas 快约 3 倍）的数据处理，便于快速实验

[新闻！] 我们正在不断将优秀的论文和基准测试整合到 PyHealth 中，请查看 [计划列表] <https://docs.google.com/spreadsheets/d/1PNMgDe-llOm1SM5ZyGLkmPysjC4wwaVblPLAHLxejTw/edit#gid=159213380>_。欢迎从列表中选择一篇，向我们提交 PR，或将更多有影响力的新论文添加到计划列表中。

.. image:: figure/poster.png :width: 810

..

1. 安装 :rocket:

---

Python 版本要求

PyHealth 2.0 需要 Python 3.12 或 3.13（>=3.12,<3.14）。这一版本要求能够实现最佳的并行处理、内存管理，并与我们现代依赖项兼容。

推荐安装方式（最新版本）

从 PyPI 安装最新的 PyHealth 2.0 版本：

.. code-block:: sh

pip install pyhealth

此版本包含显著的性能提升、动态内存支持、并行化处理、多模态数据加载器以及许多新功能。

旧版

较旧的稳定版本（1.16）仍然可用，以确保向后兼容性，并支持 Python 3.9 及以上版本：

.. code-block:: sh

pip install pyhealth==1.16

面向贡献者和开发者

如果您正在为 PyHealth 做贡献，或需要最新的开发功能，请从 GitHub 源代码安装：

.. code-block:: sh

git clone https://github.com/sunlabuiuc/PyHealth.git
cd PyHealth
pip install -e .

注意： PyHealth 2.0 会自动安装 PyTorch 和其他深度学习依赖项。Alpha 版本包含了所有基于神经网络模型所需的库。

2. 简介 :book:

---

pyhealth 提供以下功能（我们仍在丰富部分模块）：

.. image:: figure/overview.png :width: 770

您可以独立使用以下功能：

• 数据集: MIMIC-III、MIMIC-IV、eICU、OMOP-CDM、EHRShot、COVID19-CXR、SleepEDF、SHHS、ISRUC、自定义电子健康记录数据集等。
• 任务: 基于诊断的药物推荐、患者住院及死亡率预测、再入院预测、住院时长预测、睡眠分期等。
• 机器学习模型: RNN、LSTM、GRU、Transformer、RETAIN、SafeDrug、GAMENet、MoleRec、AdaCare、ConCare、StageNet、GRASP、SparcNet、ContraWR、Deepr、TCN、Dr. Agent等。

使用PyHealth构建医疗AI流水线，代码量可短至10行。

3. 构建机器学习流水线 :trophy:

---

我们包中的所有医疗任务都遵循一个五阶段流水线：

.. image:: figure/five-stage-pipeline.png :width: 640

..

我们尽力确保每个阶段尽可能独立，以便用户仅使用我们的数据处理步骤或机器学习模型即可自定义自己的流水线。

模块1: <pyhealth.datasets> """"""""""""""""""""""""""""""""""""

pyhealth.datasets为数据集提供了一个干净的结构，与具体任务无关。我们支持MIMIC-III、MIMIC-IV、eICU、OMOP-CDM等数据集。其输出（mimic3base）是一个多级字典结构（见下图）。

.. code-block:: python

from pyhealth.datasets import MIMIC3Dataset

mimic3base = MIMIC3Dataset(
    # 数据集的根目录
    root="https://storage.googleapis.com/pyhealth/Synthetic_MIMIC-III/",
    # 原始CSV表名
    tables=["DIAGNOSES_ICD", "PROCEDURES_ICD", "PRESCRIPTIONS"],
    # 将这些表中的所有NDC编码映射到CCS编码
    code_mapping={"NDC": "CCSCM"},
)

.. image:: figure/structured-dataset.png :width: 400

..

模块2: <pyhealth.tasks> """"""""""""""""""""""""""""""""""""

pyhealth.tasks定义了如何将每位患者的数据处理成用于特定任务的一组样本。在本包中，我们提供了多个任务示例，如药物推荐、死亡率预测和再入院预测。您可以按照我们的 模板 <https://colab.research.google.com/drive/1r7MYQR_5yCJGpK_9I9-A10HmpupZuIN-?usp=sharing>_ 轻松自定义自己的任务。

.. code-block:: python

from pyhealth.tasks import ReadmissionPredictionMIMIC3

mimic3sample = mimic3base.set_task(ReadmissionPredictionMIMIC3())
mimic3sample[0] # 显示第一个样本的信息

from pyhealth.datasets import split_by_patient, get_dataloader

train_ds、val_ds、test_ds = split_by_patient(mimic3sample, [0.8, 0.1, 0.1])
train_loader = get_dataloader(train_ds, batch_size=32, shuffle=True)
val_loader = get_dataloader(val_ds, batch_size=32, shuffle=False)
test_loader = get_dataloader(test_ds, batch_size=32, shuffle=False)

模块3: <pyhealth.models> """"""""""""""""""""""""""""""""""""

pyhealth.models提供了多种机器学习模型，它们的参数配置非常相似。

.. code-block:: python

from pyhealth.models import Transformer

model = Transformer(
    dataset=mimic3sample,
)

模块4: <pyhealth.trainer> """"""""""""""""""""""""""""""""""""

pyhealth.trainer可以指定训练参数，如轮数、优化器、学习率等。训练器会自动保存最佳模型，并在最后输出模型路径。

.. code-block:: python

from pyhealth.trainer import Trainer

trainer = Trainer(model=model)
trainer.train(
    train_dataloader=train_loader,
    val_dataloader=val_loader,
    epochs=50,
    monitor="pr_auc_samples",
)

模块5: <pyhealth.metrics> """"""""""""""""""""""""""""""""""""

pyhealth.metrics提供了若干常用评估指标（请参阅文档 <https://pyhealth.readthedocs.io/en/latest/api/metrics.html>_以了解可用指标）。

.. code-block:: python

# 方法1
trainer.evaluate(test_loader)

# 方法2
from pyhealth.metrics.binary import binary_metrics_fn

y_true、y_prob、loss = trainer.inference(test_loader)
binary_metrics_fn(y_true、y_prob、metrics=["pr_auc"、"roc_auc"])

4. 医疗编码映射 :hospital:

---

pyhealth.codemap提供了两项核心功能。该模块可独立使用。

• 用于在单一医疗编码系统内进行编码本体查询（例如，名称、类别、子概念）；

.. code-block:: python

from pyhealth.medcode import InnerMap

icd9cm = InnerMap.load("ICD9CM")
icd9cm.lookup("428.0")
# `充血性心力衰竭，未特指`
icd9cm.get_ancestors("428.0")
# ['428'、'420-429.99'、'390-459.99'、'001-999.99']

atc = InnerMap.load("ATC")
atc.lookup("M01AE51")
# `布洛芬，复方制剂`
atc.lookup("M01AE51"、"drugbank_id")
# `DB01050`
atc.lookup("M01AE51"、"description")
# 布洛芬是一种非甾体抗炎药（NSAID），来源于…
atc.lookup("M01AE51"、"indication")
# 布洛芬是最常用且最常被处方的NSAID。它在临床上非常常见……

• 用于在两个编码系统之间进行编码映射（例如，ICD9CM到CCSCM）。

.. code-block:: python

from pyhealth.medcode import CrossMap

codemap = CrossMap.load("ICD9CM"、"CCSCM")
codemap.map("428.0")
# ['108']

codemap = CrossMap.load("NDC"、"RxNorm")
codemap.map("50580049698")
# ['209387']

codemap = CrossMap.load("NDC"、"ATC")
codemap.map("50090539100")
# ['A10AC04'、'A10AD04'、'A10AB04']

5. 医疗编码分词器 :speech_balloon:

---

pyhealth.tokenizer用于在基于字符串的标记和基于整数的索引之间进行转换，基于整体标记空间。我们提供了灵活的函数来对1D、2D和3D列表进行分词。该模块可独立使用。

.. code-block:: python

from pyhealth.tokenizer import Tokenizer

# 示例：我们使用ATC3编码列表作为标记
token_space = ['A01A'、'A02A'、'A02B'、'A02X'、'A03A'、'A03B'、'A03C'、'A03D'、\
        'A03F'、'A04A'、'A05A'、'A05B'、'A05C'、'A06A'、'A07A'、'A07B'、'A07C'、\
        'A12B'、'A12C'、'A13A'、'A14A'、'A14B'、'A16A']
tokenizer = Tokenizer(tokens=token_space、special_tokens=["<pad>"、"<unk>"])

# 2D编码
tokens = [['A03C'、'A03D'、'A03E'、'A03F']、['A04A'、'B035'、'C129']]
indices = tokenizer.batch_encode_2d(tokens)
# [[8、9、10、11]、[12、1、1、0]]

# 2D解码
indices = [[8、9、10、11]、[12、1、1、0]]
tokens = tokenizer.batch_decode_2d(indices)
# [['A03C'、'A03D'、'A03E'、'A03F']、['A04A'、'<unk>'、'<unk>']]

# 3D编码
tokens = [[['A03C'、'A03D'、'A03E'、'A03F']、['A08A'、'A09A']]、\
    [['A04A'、'B035'、'C129']]]
indices = tokenizer.batch_encode_3d(tokens)
# [[[8、9、10、11]、[24、25、0、0]]、[[12、1、1、0]、[0、0、0、0]]]

3D解码

indices = [[[8, 9, 10, 11], [24, 25, 0, 0]], \
    [[12, 1, 1, 0], [0, 0, 0, 0]]]
tokens = tokenizer.batch_decode_3d(indices)
# [[['A03C', 'A03D', 'A03E', 'A03F'], ['A08A', 'A09A']], [['A04A', '<unk>', '<unk>']]]

..

6. 教程 :teacher:

---

.. image:: https://colab.research.google.com/assets/colab-badge.svg :target: https://pyhealth.readthedocs.io/en/latest/tutorials.html

..

我们提供以下教程，帮助用户快速上手我们的 pyhealth。请耐心等待我们更新关于如何使用 PyHealth 2.0 的文档。

教程0：pyhealth.data简介 <https://colab.research.google.com/drive/1y9PawgSbyMbSSMw1dpfwtooH7qzOEYdN?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=Nk1itBoLOX8&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=2>__

教程1：pyhealth.datasets简介 <https://colab.research.google.com/drive/1voSx7wEfzXfEf2sIfW6b-8p1KqMyuWxK?usp=sharing>_ [视频（PyHealth 1.16）] <https://www.youtube.com/watch?v=c1InKqFJbsI&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=3>__

教程2：pyhealth.tasks简介 <https://colab.research.google.com/drive/1kKkkBVS_GclHoYTbnOtjyYnSee79hsyT?usp=sharing>_ [视频（PyHealth 1.16）] <https://www.youtube.com/watch?v=CxESe1gYWU4&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=4>__

教程3：pyhealth.models简介 <https://colab.research.google.com/drive/1LcXZlu7ZUuqepf269X3FhXuhHeRvaJX5?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=fRc0ncbTgZA&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=6>__

教程4：pyhealth.trainer简介 <https://colab.research.google.com/drive/1L1Nz76cRNB7wTp5Pz_4Vp4N2eRZ9R6xl?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=5Hyw3of5pO4&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=7>__

教程5：pyhealth.metrics简介 <https://colab.research.google.com/drive/1Mrs77EJ92HwMgDaElJ_CBXbi4iABZBeo?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=d-Kx_xCwre4&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=8>__

教程6：pyhealth.tokenizer简介 <https://colab.research.google.com/drive/1bDOb0A5g0umBjtz8NIp4wqye7taJ03D0?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=CeXJtf0lfs0&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=10>__

教程7：pyhealth.medcode简介 <https://colab.research.google.com/drive/1xrp_ACM2_Hg5Wxzj0SKKKgZfMY0WwEj3?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=MmmfU6_xkYg&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=9>__

以下教程将帮助用户构建自己的任务流水线。

流水线1：胸部X光片分类 <https://colab.research.google.com/drive/18vK23gyI1LjWbTgkq4f99yDZA3A7Pxp9?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=GGP3Dhfyisc&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=12>__

流水线2：医学编码 <https://colab.research.google.com/drive/1ThYP_5ng5xPQwscv5XztefkkoTruhjeK?usp=sharing>

流水线3：医疗转录分类 <https://colab.research.google.com/drive/1bjk_IArc2ZmXGR6u6Qzyf7kh70RdiY9c?usp=sharing>

流水线4：死亡率预测 <https://colab.research.google.com/drive/1b9xRbxUz-HLzxsrvxdsdJ868ajGQCY6U?usp=sharing>

流水线5：再入院预测 <https://colab.research.google.com/drive/1h0pAymUlPQfkLFryI9QI37-HAW1tRxGZ?usp=sharing>_

我们提供高级教程，以满足各种需求。

高级教程1：将您的数据集适配到我们的流水线中 <https://colab.research.google.com/drive/1UurxwAAov1bL_5OO3gQJ4gAa_paeJwJp?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=xw2hGLEQ4Y0&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=13>__

高级教程2：定义您自己的医疗保健任务 <https://colab.research.google.com/drive/1gK6zPXvfFGBM1uNaLP32BOKrnnJdqRq2?usp=sharing>

高级教程3：将自定义模型引入pyhealth <https://colab.research.google.com/drive/1F_NJ90GC8_Eq-vKTf7Tyziew4gWjjKoH?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=lADFlcmLtdE&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=14>__

高级教程4：将您自己处理好的数据加载到pyhealth中，并尝试我们的机器学习模型 <https://colab.research.google.com/drive/1ZRnKch2EyJLrI3G5AvDXVpeE2wwgBWfw?usp=sharing>_ [视频] <https://www.youtube.com/watch?v=xw2hGLEQ4Y0&list=PLR3CNIF8DDHJUl8RLhyOVpX_kT4bxulEV&index=13>__

7. 数据集 :mountain_snow:

---

我们为以下开放的电子健康记录（EHR）数据集提供了处理文件：

=================== ======================================= ======================================== ======================================================================================================== MIMIC-III pyhealth.datasets.MIMIC3Dataset 2016 MIMIC-III临床数据库 <https://physionet.org/content/mimiciii/1.4//>_ MIMIC-IV pyhealth.datasets.MIMIC4Dataset 2020 MIMIC-IV临床数据库 <https://physionet.org/content/mimiciv/0.4/>_ eICU pyhealth.datasets.eICUDataset 2018 eICU协作研究数据库 <https://eicu-crd.mit.edu//>_ OMOP pyhealth.datasets.OMOPDataset 基于OMOP-CDM模式的数据集 <https://www.ohdsi.org/data-standardization/the-common-data-model/>_ EHRShot pyhealth.datasets.EHRShotDataset 2023 小样本EHR基准测试数据集 <https://github.com/som-shahlab/ehrshot-benchmark>_ COVID19-CXR pyhealth.datasets.COVID19CXRDataset 2020 COVID-19胸部X光图像数据集 SleepEDF pyhealth.datasets.SleepEDFDataset 2018 Sleep-EDF数据集 <https://physionet.org/content/sleep-edfx/1.0.0/>_ SHHS pyhealth.datasets.SHHSDataset 2016 睡眠心脏健康研究数据集 <https://sleepdata.org/datasets/shhs>_ ISRUC pyhealth.datasets.ISRUCDataset 2016 ISRUC-SLEEP数据集 <https://sleeptight.isr.uc.pt/?page_id=48>_ =================== ======================================= ======================================== ========================================================================================================

8. 机器学习/深度学习模型 :airplane:

---

深度学习模型

================================== ====== ============================================================================================================ 模型 年份 关键创新 ================================== ====== ============================================================================================================ RETAIN 2016 面向临床决策的可解释注意力机制 GAMENet 2019 用于药物推荐的记忆网络 SafeDrug 2021 基于分子图的安全药物组合方法 MoleRec 2023 子结构感知的药物推荐 AdaCare 2020 尺度自适应特征提取 ConCare 2020 基于Transformer的患者建模 StageNet 2020 疾病进展阶段建模 GRASP 2021 用于患者聚类的图神经网络 MICRON 2021 基于循环残差网络的用药变化预测 ================================== ====== ============================================================================================================

基础模型

================================== ====== ============================================================================================================ 模型 年份 描述 ================================== ====== ============================================================================================================ Transformer 2017 基于注意力机制的序列建模 RNN/LSTM/GRU 2011 用于序列的循环神经网络 CNN 1989 用于结构化数据的卷积网络 TCN 2018 时间卷积网络 MLP 1986 用于表格数据的多层感知机 ================================== ====== ============================================================================================================

专用模型

================================== ====== ============================================================================================================ 模型 年份 专长领域 ================================== ====== ============================================================================================================ ContraWR 2021 生物信号分析（脑电图、心电图） SparcNet 2023 癫痫发作检测与睡眠分期 Deepr 2017 电子健康记录 Dr. Agent 2020 用于临床决策的强化学习 ================================== ====== ============================================================================================================

• 请查看基准EHR预测任务的交互式地图 https://pyhealth.readthedocs.io/en/latest/index.html#benchmark-on-healthcare-tasks。

9. 研究计划 :microscope:

---

PyHealth研究计划是一项全年开放的研究项目，汇聚来自不同背景的优秀人才，共同开展医疗AI领域的前沿研究。

参与方式：

1. 加入我们的Discord服务器 <https://discord.gg/mpb835EHaX>_
2. 向PyHealth仓库 <https://github.com/sunlabuiuc/PyHealth>_ 提交高质量的代码合并请求
3. 查阅文档 <https://pyhealth.readthedocs.io/en/latest/research_initiative.html>_ 获取更多详情

该计划近期的研究成果已发表在包括ML4H 2025在内的顶级会议上。

10. 关于我们 :busts_in_silhouette:

---

我们是伊利诺伊大学厄巴纳-香槟分校的SunLab <http://sunlab.org/>_ 医疗健康研究团队。

当前维护者：

• 吴振邦 <https://zzachw.github.io/>_ （UIUC博士生）
• 约翰·吴 <https://jhnwu3.github.io/>_ （UIUC博士生）
• 高俊毅 <http://aboutme.vixerunt.org/>_ （爱丁堡大学博士生）
• 孙继明 <http://sunlab.org/>_ （UIUC教授）

联系我们：

• Discord社区 <https://discord.gg/mpb835EHaX>_ （响应最快）
• GitHub问题 <https://github.com/sunlabuiuc/PyHealth/issues>_
• 邮件列表 <https://docs.google.com/forms/d/e/1FAIpQLSfpJB5tdkI7BccTCReoszV9cyyX2rF99SgznzwlOepi5v-xLw/viewform?usp=header>_

PyHealth 快速上手指南

PyHealth 是一个专为医疗预测建模设计的综合深度学习工具包，适用于机器学习研究人员和医疗从业者。它提供了模块化的五阶段流程，支持多种主流医疗数据集（如 MIMIC、eICU、OMOP）和 33+ 种预建模型，旨在让医疗 AI 应用的开发、测试和部署更加灵活高效。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS, 或 Windows
• Python 版本：
  • PyHealth 2.0 (推荐)：需要 Python 3.12 或 3.13 (>=3.12, <3.14)。此版本针对并行处理和内存管理进行了优化。
  • PyHealth 1.16 (旧版)：支持 Python 3.9+，仅用于向后兼容。
• 前置依赖：安装过程中会自动安装 PyTorch 及其他必要的深度学习库，无需手动预先安装。

提示：国内用户建议使用国内镜像源加速安装过程（如下方安装命令所示）。

2. 安装步骤

推荐安装（最新稳定版 PyHealth 2.0）

使用 pip 从 PyPI 安装最新版本。国内用户可添加 -i 参数使用清华或阿里镜像源。

# 使用默认源
pip install pyhealth

# 【推荐】国内用户使用清华镜像源加速
pip install pyhealth -i https://pypi.tuna.tsinghua.edu.cn/simple

开发者安装（源码安装）

如果您计划贡献代码或需要使用最新的开发功能：

git clone https://github.com/sunlabuiuc/PyHealth.git
cd PyHealth
pip install -e .

安装旧版本（可选）

如需兼容旧项目，可安装 1.16 版本：

pip install pyhealth==1.16

3. 基本使用

PyHealth 的核心优势在于其标准化的五阶段流水线（数据加载 -> 任务定义 -> 模型构建 -> 训练 -> 评估）。以下是一个基于 MIMIC-III 数据集进行再入院预测的最小化示例（约 10 行核心代码）：

步骤 1: 加载数据集

初始化数据集对象，指定根目录和需要的表格。

from pyhealth.datasets import MIMIC3Dataset

mimic3base = MIMIC3Dataset(
    root="https://storage.googleapis.com/pyhealth/Synthetic_MIMIC-III/",
    tables=["DIAGNOSES_ICD", "PROCEDURES_ICD", "PRESCRIPTIONS"],
    code_mapping={"NDC": "CCSCM"},
)

步骤 2: 定义任务与数据划分

将原始数据转换为特定任务（如再入院预测）的样本，并划分为训练集、验证集和测试集。

from pyhealth.tasks import ReadmissionPredictionMIMIC3
from pyhealth.datasets import split_by_patient, get_dataloader

# 设置任务
mimic3sample = mimic3base.set_task(ReadmissionPredictionMIMIC3())

# 划分数据集 (80% 训练，10% 验证，10% 测试)
train_ds, val_ds, test_ds = split_by_patient(mimic3sample, [0.8, 0.1, 0.1])

# 创建 DataLoader
train_loader = get_dataloader(train_ds, batch_size=32, shuffle=True)
val_loader = get_dataloader(val_ds, batch_size=32, shuffle=False)
test_loader = get_dataloader(test_ds, batch_size=32, shuffle=False)

步骤 3: 构建模型

选择预建模型（例如 Transformer），传入数据集样本以自动推断输入维度。

from pyhealth.models import Transformer

model = Transformer(
    dataset=mimic3sample,
)

步骤 4: 训练模型

使用内置 Trainer 进行训练，自动保存最佳模型。

from pyhealth.trainer import Trainer

trainer = Trainer(model=model)
trainer.train(
    train_dataloader=train_loader,
    val_dataloader=val_loader,
    epochs=50,
    monitor="pr_auc_samples",
)

步骤 5: 评估模型

在测试集上评估模型性能。

# 方法 1: 直接使用 trainer 评估
trainer.evaluate(test_loader)

# 方法 2: 获取预测结果并自定义评估
from pyhealth.metrics.binary import binary_metrics_fn

y_true, y_prob, loss = trainer.inference(test_loader)
binary_metrics_fn(y_true, y_prob, metrics=["pr_auc", "roc_auc"])

---

更多详细教程、API 文档及支持的模型列表，请访问官方文档：pyhealth.readthedocs.io