| Name | merlin-vlm JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | Merlin: A Vision Language Foundation Model for 3D Computed Tomography |
| upload_time | 2025-02-25 06:10:19 |
| maintainer | None |
| docs_url | None |
| author | Stanford Machine Intelligence for Medical Imaging (MIMI) |
| requires_python | ==3.9 |
| license | MIT License
Copyright (c) 2025 Stanford MIMI Lab
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Merlin: Vision Language Foundation Model for 3D Computed Tomography
[](https://arxiv.org/abs/2406.06512) [](https://huggingface.co/stanfordmimi/Merlin) [](https://pypi.org/project/merlin-vlm/) 
*Merlin is a 3D VLM for computed tomography that leverages both structured electronic health records (EHR) and unstructured radiology reports for pretraining.*
## ⚡️ Installation
To install Merlin, you can simply run:
```python
pip install merlin-vlm
```
For an editable installation, use the following commands to clone and install this repository.
```bash
git clone https://github.com/StanfordMIMI/Merlin.git
cd merlin
pip install -e .
```
## 🚀 Inference with Merlin
To create a Merlin model with both image and text embeddings enabled, use the following:
```python
from merlin import Merlin
model = Merlin()
```
To initialize the model with **only image embeddings** active, use:
```python
from merlin import Merlin
model = Merlin(ImageEmbedding=True)
```
#### For inference on a demo CT scan, please check out the [demo](documentation/demo.py)
#### For additional information, please read the [documentation](documentation/inference.md).
## 📎 Citation
If you find this repository useful for your work, please cite the cite the [original paper](https://arxiv.org/abs/2406.06512):
```bibtex
@article{blankemeier2024merlin,
title={Merlin: A vision language foundation model for 3d computed tomography},
author={Blankemeier, Louis and Cohen, Joseph Paul and Kumar, Ashwin and Van Veen, Dave and Gardezi, Syed Jamal Safdar and Paschali, Magdalini and Chen, Zhihong and Delbrouck, Jean-Benoit and Reis, Eduardo and Truyts, Cesar and others},
journal={Research Square},
pages={rs--3},
year={2024}
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "merlin-vlm",
"maintainer": null,
"docs_url": null,
"requires_python": "==3.9",
"maintainer_email": null,
"keywords": null,
"author": "Stanford Machine Intelligence for Medical Imaging (MIMI)",
"author_email": "Louis Blankemeier <louis.blankemeier@stanford.edu>, Ashwin Kumar <akkumar@stanford.edu>",
"download_url": "https://files.pythonhosted.org/packages/99/c4/91f91456fc575fa61e5e421ec7d3c4474e012e00e6f8de100b3c55b999bd/merlin_vlm-0.0.2.tar.gz",
"platform": null,
"description": "# Merlin: Vision Language Foundation Model for 3D Computed Tomography\n\n[](https://arxiv.org/abs/2406.06512) [](https://huggingface.co/stanfordmimi/Merlin) [](https://pypi.org/project/merlin-vlm/) \n\n*Merlin is a 3D VLM for computed tomography that leverages both structured electronic health records (EHR) and unstructured radiology reports for pretraining.*\n\n\n\n## \u26a1\ufe0f Installation\n\nTo install Merlin, you can simply run:\n\n```python\npip install merlin-vlm\n```\n\nFor an editable installation, use the following commands to clone and install this repository.\n```bash\ngit clone https://github.com/StanfordMIMI/Merlin.git\ncd merlin\npip install -e .\n```\n\n## \ud83d\ude80 Inference with Merlin\n\nTo create a Merlin model with both image and text embeddings enabled, use the following:\n```python\nfrom merlin import Merlin\n\nmodel = Merlin()\n```\n\nTo initialize the model with **only image embeddings** active, use:\n```python\nfrom merlin import Merlin\n\nmodel = Merlin(ImageEmbedding=True)\n```\n\n#### For inference on a demo CT scan, please check out the [demo](documentation/demo.py)\n\n#### For additional information, please read the [documentation](documentation/inference.md).\n\n## \ud83d\udcce Citation\nIf you find this repository useful for your work, please cite the cite the [original paper](https://arxiv.org/abs/2406.06512):\n\n```bibtex\n@article{blankemeier2024merlin,\n title={Merlin: A vision language foundation model for 3d computed tomography},\n author={Blankemeier, Louis and Cohen, Joseph Paul and Kumar, Ashwin and Van Veen, Dave and Gardezi, Syed Jamal Safdar and Paschali, Magdalini and Chen, Zhihong and Delbrouck, Jean-Benoit and Reis, Eduardo and Truyts, Cesar and others},\n journal={Research Square},\n pages={rs--3},\n year={2024}\n}\n```\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Stanford MIMI Lab\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.",
"summary": "Merlin: A Vision Language Foundation Model for 3D Computed Tomography",
"version": "0.0.2",
"project_urls": {
"homepage": "https://github.com/StanfordMIMI/Merlin",
"repository": "https://github.com/StanfordMIMI/Merlin"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e6a9f01699ab29ee504252a70f96be6502cf81d111ce2aa03f1f1be015d9bb33",
"md5": "1a100fe529d2c6f5b2ba78f6009ccd5d",
"sha256": "92f2925cc70de3a7361948a03bec1446c17e3a247b18d615d6bce8e700bdd34a"
},
"downloads": -1,
"filename": "merlin_vlm-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a100fe529d2c6f5b2ba78f6009ccd5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "==3.9",
"size": 12132,
"upload_time": "2025-02-25T06:10:17",
"upload_time_iso_8601": "2025-02-25T06:10:17.294681Z",
"url": "https://files.pythonhosted.org/packages/e6/a9/f01699ab29ee504252a70f96be6502cf81d111ce2aa03f1f1be015d9bb33/merlin_vlm-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "99c491f91456fc575fa61e5e421ec7d3c4474e012e00e6f8de100b3c55b999bd",
"md5": "f0079a905eab5ad72dd148fbbe71f911",
"sha256": "1cfdd65f1bba253808360aafb7a417c6dbb45fe4956318b4dd446d0919b531e9"
},
"downloads": -1,
"filename": "merlin_vlm-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f0079a905eab5ad72dd148fbbe71f911",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "==3.9",
"size": 11356,
"upload_time": "2025-02-25T06:10:19",
"upload_time_iso_8601": "2025-02-25T06:10:19.003731Z",
"url": "https://files.pythonhosted.org/packages/99/c4/91f91456fc575fa61e5e421ec7d3c4474e012e00e6f8de100b3c55b999bd/merlin_vlm-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-25 06:10:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "StanfordMIMI",
"github_project": "Merlin",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "merlin-vlm"
}
