Skip to content

Commit 7ee2f38

Browse files
authored
Update README.md
1 parent c29c39f commit 7ee2f38

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
[![arXiv](https://img.shields.io/badge/arXiv-2508.15904-b31b1b.svg)](https://arxiv.org/abs/2508.15904)
88
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
99
[![Python](https://img.shields.io/badge/Python-3.8+-3776ab.svg)](https://www.python.org/)
10-
[![PyTorch](https://img.shields.io/badge/PyTorch-1.9+-ee4c2c.svg)](https://pytorch.org/)
1110

12-
[📄 Paper](https://arxiv.org/abs/2508.15904)[🔧 Quick Start](#-quick-start)[📊 Benchmark](#-benchmark)[💡 Citation](#-citation)
11+
[📄 Paper](https://arxiv.org/abs/2508.15904)[🔧 Quick Start](#-quick-start)[📊 Benchmark](#-benchmark-results)[💡 Citation](#-citation)
1312

1413
</div>
1514

@@ -52,11 +51,11 @@
5251
### 📦 Installation
5352

5453
```bash
55-
# 🐍 Create and activate conda environment
54+
# Create and activate conda environment
5655
conda create -n pathpt python=3.8 -y
5756
conda activate pathpt
5857

59-
# 📥 Install dependencies
58+
# Install dependencies
6059
pip install -r requirements.txt
6160
```
6261

@@ -81,11 +80,7 @@ Want to use your own datasets and foundation models? We've got you covered! 🎉
8180

8281
### 🤖 Base Model Setup
8382

84-
Download your foundation model into `./base_models/`, e.g.:
85-
- 🔥 [KEEP](https://huggingface.co/Astaxanthin/KEEP) [[1]](https://arxiv.org/abs/2412.13126)
86-
- 🧠 [CONCH](https://huggingface.co/MahmoodLab/conch) [[2]](https://www.nature.com/articles/s41591-024-02856-4)
87-
- 🦣 [MUSK](https://huggingface.co/xiangjx/musk) [[3]](https://www.nature.com/articles/s41586-024-08378-w)
88-
- 🖼️ [PLIP](https://huggingface.co/vinid/plip) [[4]](https://www.nature.com/articles/s41591-023-02504-3)
83+
Download your foundation model into `./base_models/`, e.g.: [KEEP](https://huggingface.co/Astaxanthin/KEEP) [[1]](https://arxiv.org/abs/2412.13126), [CONCH](https://huggingface.co/MahmoodLab/conch) [[2]](https://www.nature.com/articles/s41591-024-02856-4), [MUSK](https://huggingface.co/xiangjx/musk) [[3]](https://www.nature.com/articles/s41586-024-08378-w), [PLIP](https://huggingface.co/vinid/plip) [[4]](https://www.nature.com/articles/s41591-023-02504-3).
8984

9085
> **💡 Important**: Only vision-language models with patch encoders are supported!
9186
@@ -134,19 +129,19 @@ from transformers import AutoModel
134129
from torchvision import transforms
135130
from PIL import Image
136131

137-
# 🚀 Load your base model
132+
# Load your base model
138133
model = AutoModel.from_pretrained("Astaxanthin/KEEP", trust_remote_code=True)
139134
model.eval()
140135

141-
# 🖼Setup transforms
136+
# 🖼Setup transforms
142137
transform = transforms.Compose([
143138
transforms.Resize(size=224, interpolation=transforms.InterpolationMode.BICUBIC),
144139
transforms.CenterCrop(size=(224, 224)),
145140
transforms.ToTensor(),
146141
transforms.Normalize(mean=(0.485, 0.456, 0.406), std=(0.229, 0.224, 0.225))
147142
])
148143

149-
# 📸 Process patch
144+
# Process patch
150145
example_patch_path = 'YOUR_PATCH_IMG_FILE'
151146
example_patch = Image.open(example_patch_path).convert('RGB')
152147
patch_feature = model.encode_image(transform(example_patch).unsqueeze(0))
@@ -188,10 +183,10 @@ subtype_params['your_dataset'] = {
188183

189184
#### 2️⃣ Modify `./train.py`:
190185
```python
191-
# 🔄 Change import to your model
186+
# Change import to your model
192187
from subtyping.main_wsi_subtyping_YOUR_MODEL import main_subtyping
193188

194-
# 🎯 Set your dataset
189+
# Set your dataset
195190
proc_tumor = 'your_dataset'
196191
```
197192

@@ -251,12 +246,7 @@ Using foundation models: **PLIP**, **MUSK**, **CONCH**, and **KEEP**.
251246

252247
## 🙏 Acknowledgments
253248

254-
This project builds upon amazing work from the community:
255-
- 🔬 [CLAM](https://github.com/mahmoodlab/CLAM)
256-
- 🎯 [CoOp](https://github.com/KaiyangZhou/CoOp)
257-
- 🚀 [TransMIL](https://github.com/szc19990412/TransMIL)
258-
259-
Big thanks to all the authors and developers! 👏
249+
This project builds upon amazing work from the community such as [CLAM](https://github.com/mahmoodlab/CLAM), [CoOp](https://github.com/KaiyangZhou/CoOp), [TransMIL](https://github.com/szc19990412/TransMIL). Big thanks to all the authors and developers! 👏
260250

261251
---
262252

@@ -285,4 +275,5 @@ If you find our work useful, please consider citing our paper:
285275
286276
[![Star History Chart](https://api.star-history.com/svg?repos=your-username/PathPT&type=Date)](https://star-history.com/#your-username/PathPT&Date)
287277
288-
</div> -->
278+
279+
</div> -->

0 commit comments

Comments
 (0)