Update README.md
Browse files
README.md
CHANGED
|
@@ -53,7 +53,7 @@ This model is a Vision Transformer adapted for neuropathology tasks, developed u
|
|
| 53 |
|
| 54 |
* **Model Type:** Vision Transformer (ViT) for neuropathology.
|
| 55 |
* **Developed by:** Center for Applied Artificial Intelligence (CAAI)
|
| 56 |
-
* **Model Date:** 05/
|
| 57 |
* **Base Model Architecture:** Dinov2-giant (https://huggingface.co/facebook/dinov2-giant)
|
| 58 |
* **Input:** Image (224x224).
|
| 59 |
* **Output:** Class token and patch tokens. These can be used for various downstream tasks (e.g., classification, segmentation, similarity search).
|
|
@@ -62,14 +62,7 @@ This model is a Vision Transformer adapted for neuropathology tasks, developed u
|
|
| 62 |
* **Image Size Compatibility:**
|
| 63 |
* The model was trained on images/patches of size 224x224.
|
| 64 |
* The model can accept images of any size, not just the 224x224 dimensions used in training.
|
| 65 |
-
* **License:**
|
| 66 |
-
* **Repository:** [PLACEHOLDER: Link to your model repository (e.g., GitHub, Hugging Face Hub)]
|
| 67 |
-
* **Paper(s)/Reference(s):**
|
| 68 |
-
* [PLACEHOLDER: Link to your paper if applicable]
|
| 69 |
-
* [Optional: Link to relevant University of Kentucky data descriptor or study paper]
|
| 70 |
-
* Oquab et al., "DINOv2: Learning Robust Visual Features without Supervision" (https://arxiv.org/abs/2304.07193)
|
| 71 |
-
* Darcet et al., "Vision Transformers Need Registers" (https://arxiv.org/abs/2309.16588) (if registers are used)
|
| 72 |
-
* **Demo:** [PLACEHOLDER: Link to your demo, if any]
|
| 73 |
|
| 74 |
## Intended Uses
|
| 75 |
|
|
@@ -80,9 +73,8 @@ This model is intended for research purposes in the field of neuropathology.
|
|
| 80 |
* Feature extraction for quantitative analysis of neuropathology.
|
| 81 |
## How to Get Started with the Model
|
| 82 |
|
| 83 |
-
[PLACEHOLDER: Provide code snippets for loading and using your model. If available on Hugging Face, show an example using `transformers` or `torch.hub.load`.]
|
| 84 |
|
| 85 |
-
|
| 86 |
```python
|
| 87 |
|
| 88 |
import torch
|
|
@@ -214,8 +206,8 @@ if __name__ == "__main__":
|
|
| 214 |
## Training Data
|
| 215 |
|
| 216 |
* **Dataset(s):** The model was trained on data from the University of Kentucky.
|
| 217 |
-
* **Name/Identifier:**
|
| 218 |
-
* **Source:** University of Kentucky, [PLACEHOLDER: Specific Department, Center, or PI, e.g., Sanders-Brown Center on Aging, Department of Pathology]
|
| 219 |
* **Description:** [PLACEHOLDER: Describe the data. E.g., "Digitized whole slide images (WSIs) of human post-mortem brain tissue sections from [number] subjects. Sections were stained with [e.g., Hematoxylin and Eosin (H&E), and immunohistochemistry for Amyloid-beta (Aβ) and phosphorylated Tau (pTau)]. Images were acquired using [e.g., Aperio AT2 scanner at 20x magnification]."]
|
| 220 |
* **Preprocessing:** [PLACEHOLDER: Describe significant preprocessing steps. E.g., "WSIs were tiled into non-overlapping [e.g., 224x224 pixel] patches. Tiles with excessive background or artifacts were excluded. Color normalization using [Method, e.g., Macenko method] was applied."]
|
| 221 |
* **Annotation (if applicable for supervised fine-tuning or evaluation):** [PLACEHOLDER: Describe the annotation process. E.g., "Regions of interest (ROIs) for [pathologies] were annotated by board-certified neuropathologists. For classification tasks, slide-level or region-level labels for [disease/pathology presence/severity] were provided."]
|
|
|
|
| 53 |
|
| 54 |
* **Model Type:** Vision Transformer (ViT) for neuropathology.
|
| 55 |
* **Developed by:** Center for Applied Artificial Intelligence (CAAI)
|
| 56 |
+
* **Model Date:** 05/2025
|
| 57 |
* **Base Model Architecture:** Dinov2-giant (https://huggingface.co/facebook/dinov2-giant)
|
| 58 |
* **Input:** Image (224x224).
|
| 59 |
* **Output:** Class token and patch tokens. These can be used for various downstream tasks (e.g., classification, segmentation, similarity search).
|
|
|
|
| 62 |
* **Image Size Compatibility:**
|
| 63 |
* The model was trained on images/patches of size 224x224.
|
| 64 |
* The model can accept images of any size, not just the 224x224 dimensions used in training.
|
| 65 |
+
* **License:** Apache 2.0
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 66 |
|
| 67 |
## Intended Uses
|
| 68 |
|
|
|
|
| 73 |
* Feature extraction for quantitative analysis of neuropathology.
|
| 74 |
## How to Get Started with the Model
|
| 75 |
|
|
|
|
| 76 |
|
| 77 |
+
Three example methods using Hugging Face `transformers` (adjust based on your actual model and task):
|
| 78 |
```python
|
| 79 |
|
| 80 |
import torch
|
|
|
|
| 206 |
## Training Data
|
| 207 |
|
| 208 |
* **Dataset(s):** The model was trained on data from the University of Kentucky.
|
| 209 |
+
* **Name/Identifier:** UK Alzheimer's Disease Center Neuropathology Whole Slide Image Cohort [BDSA TEST v1.0]
|
| 210 |
+
* **Source:** [UK-ADRC Neuropathology Lab at the University of Kentucky University of Kentucky](https://neuropathlab.createuky.net/), [PLACEHOLDER: Specific Department, Center, or PI, e.g., Sanders-Brown Center on Aging, Department of Pathology]
|
| 211 |
* **Description:** [PLACEHOLDER: Describe the data. E.g., "Digitized whole slide images (WSIs) of human post-mortem brain tissue sections from [number] subjects. Sections were stained with [e.g., Hematoxylin and Eosin (H&E), and immunohistochemistry for Amyloid-beta (Aβ) and phosphorylated Tau (pTau)]. Images were acquired using [e.g., Aperio AT2 scanner at 20x magnification]."]
|
| 212 |
* **Preprocessing:** [PLACEHOLDER: Describe significant preprocessing steps. E.g., "WSIs were tiled into non-overlapping [e.g., 224x224 pixel] patches. Tiles with excessive background or artifacts were excluded. Color normalization using [Method, e.g., Macenko method] was applied."]
|
| 213 |
* **Annotation (if applicable for supervised fine-tuning or evaluation):** [PLACEHOLDER: Describe the annotation process. E.g., "Regions of interest (ROIs) for [pathologies] were annotated by board-certified neuropathologists. For classification tasks, slide-level or region-level labels for [disease/pathology presence/severity] were provided."]
|