Skip to main content

Composite metrics for chest X-ray report (CXR) generation.

Project description

rad-metric

Composite metrics for chest X-ray report (CXR) generation with minimal dependencies and no version caps on pytroch/transformers.

Supported metrics:

  • BLEU
  • BertScore
  • SembScore
  • CheXbert
  • RadGraph
  • RaTEScore

Major dependencies (will be handled by pip)

pytorch>=2.1
transformers>=4.39.0
ray

Setup

pip install rad-metric

Usage

We use ray to initialize the evaluation workers, CPU for BLEU and GPU for the rest. By default, it will use all the available GPU devices in the current machine. If you want to run this metric software on multi-node cluster, initialize ray yourself and add more nodes as you need.

Refer to example.py for example usages.

Reference

Please prioritize to cite the original contributors of each metric.

BLEU:

@inproceedings{bleu02,
  year = {2002},
  url = {https://doi.org/10.3115/1073083.1073135},
  author = {Papineni, Kishore and Roukos, Salim and Ward, Todd and Zhu, Wei-Jing},
  booktitle = {Annual Meeting of the Association for Computational Linguistics (ACL)},
  title = {{{BLEU}}: A Method for Automatic Evaluation of Machine Translation}
}

RadGraph

@inproceedings{jainRadGraphExtractingClinical2021,
  year = {2021},
  url = {https://doi.org/10.48550/arXiv.2106.14463},
  author = {Jain, Saahil and Agrawal, Ashwin and Saporta, Adriel and Truong, Steven QH and Duong, Du Nguyen and Bui, Tan and Chambon, Pierre and Zhang, Yuhao and Lungren, Matthew P. and Ng, Andrew Y. and Langlotz, Curtis P. and Rajpurkar, Pranav},
  booktitle = {Conference on Neural Information Processing Systems (NeurIPS)},
  title = {{{RadGraph}}: {{Extracting Clinical Entities}} and {{Relations}} from {{Radiology Reports}}}
}

SembScore and F1CheXbert

@inproceedings{smitCheXbertCombiningAutomatic2020,
  year = {2020},
  url = {https://doi.org/10.48550/arXiv.2004.09167},
  author = {Smit, Akshay and Jain, Saahil and Rajpurkar, Pranav and Pareek, Anuj and Ng, Andrew Y. and Lungren, Matthew P.},
  booktitle = {Conference on Empirical Methods in Natural Language Processing (EMNLP)},
  title = {{{CheXbert}}: {{Combining Automatic Labelers}} and {{Expert Annotations}} for {{Accurate Radiology Report Labeling Using BERT}}}
}

RaTEScore

@inproceedings{zhaoRaTEScoreMetricRadiology2024,
  year = {2024},
  url = {https://doi.org/10.18653/v1/2024.emnlp-main.836},
  author = {Zhao, Weike and Wu, Chaoyi and Zhang, Xiaoman and Zhang, Ya and Wang, Yanfeng and Xie, Weidi},
  booktitle = {Conference on Empirical Methods in Natural Language Processing (EMNLP)},
  title = {{{RaTEScore}}: {{A Metric}} for {{Radiology Report Generation}}}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rad_metric-0.1.3.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rad_metric-0.1.3-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file rad_metric-0.1.3.tar.gz.

File metadata

  • Download URL: rad_metric-0.1.3.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for rad_metric-0.1.3.tar.gz
Algorithm Hash digest
SHA256 57feb936badd19d478e05fea11759fb514e5b22822a3c631ee90e5a92e72ff36
MD5 810aaff457ce6c3668148a9250348df9
BLAKE2b-256 9a3092d8a8d88ebe2413c462f7ebe87c599f4527e1bf43fed617001ff6c34a21

See more details on using hashes here.

File details

Details for the file rad_metric-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: rad_metric-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for rad_metric-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9894f3a4e32bdffb98227725e07336f6513a5210d25be53be4af1016c83af182
MD5 943855495f1e1b427be7865c1eaf31c1
BLAKE2b-256 b3808cfc0c5fde7a990cccfbb6559305568aa620886386aaf4a43a4a642ada17

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page