Skip to content

Commit 957d551

Browse files
mart-rTom Searle
authored andcommitted
docs(medcat): CU-869ar9dcf Fix demo and example model links (#164)
* CU-869ar9dcf: Update README to include available models. Now including v2 models on the v2 demo as well as list of v1 models and guidance on model conversion * CU-869ar9dcf: Update demo link in README * CU-869ar9dcf: Update tutorials link to relative link * CU-869ar9dcf: Update README with note/news of new models * CU-869ar9dcf: Fix relative link * CU-869ar9dcf: Fix another relative link
1 parent 394c994 commit 957d551

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

medcat-v2/README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,23 @@ Details on breaking are outlined [here](docs/breaking_changes.md).
1818

1919
## Available Models
2020

21-
As MedCAT v2 is still in early release, we do not currently have any models publically available.
22-
You can still use models for v1, however (see the [README](https://github.com/CogStack/cogstack-nlp/blob/main/medcat-v2/README.md) there).
21+
We have 2 public v2 models available:
22+
1) SnomedCT UK Clinical edition 39.0 (Oct 2024) and UK Drug Extension 39.0 (July 2024) based model enriched with UMLS 2024AA; trained only on MIMIC-IV
23+
2) SnomedCT UK Clinical edition 40.2 (June 2025) and UK Drug Extension 40.3 (July 2024) based model enriched with UMLS 2024AA; trained only on MIMIC-IV
2324

24-
If you wish you can also convert the v1 models into the v2 format (see [tutorial](https://github.com/CogStack/cogstack-nlp/blob/main/medcat-v2-tutorials/notebooks/introductory/migration/1._Migrate_v1_model_to_v2.ipynb)).
25+
We also have a number of MedCAT v1 models available:
26+
1) UMLS Small (A modelpack containing a subset of UMLS (disorders, symptoms, medications...). Trained on MIMIC-III)
27+
2) SNOMED International (Full SNOMED modelpack trained on MIMIC-III)
28+
3) UMLS Dutch v1.10 (a modelpack provided by UMC Utrecht containing [UMLS entities with Dutch names](https://github.com/umcu/dutch-umls) trained on Dutch medical wikipedia articles and a negation detection model [repository](https://github.com/umcu/negation-detection/)/[paper](https://doi.org/10.48550/arxiv.2209.00470) trained on EMC Dutch Clinical Corpus).
29+
4) UMLS Full. >4MM concepts trained self-supervised on MIMIC-III. v2022AA of UMLS.
30+
5) The same 2024 based model as above in v1 format
31+
6) The same 2025 based model as above in v1 format
32+
33+
To download any of these models, please [follow this link](https://uts.nlm.nih.gov/uts/login?service=https://medcat.sites.er.kcl.ac.uk/auth-callback) (or [this link for API key based download](https://medcat.sites.er.kcl.ac.uk/auth-callback-api)) and sign into your NIH profile / UMLS license. You will then be redirected to the MedCAT model download form. Please complete this form and you will be provided a download link.
34+
35+
While we encourage you use MedCAT v2 and the models in that native format, if you download an older version MedCAT v2 will be able to load it and covnert it to the format it knows. However, the loading process will be considerably longerin those cases.
36+
37+
If you wish you can also convert the v1 models into the v2 format (see [tutorial](../medcat-v2-tutorials/notebooks/introductory/migration/1._Migrate_v1_model_to_v2.ipynb)).
2538

2639
```python
2740
from medcat.utils.legacy import legacy_converter
@@ -38,6 +51,7 @@ new_model_folder = "models" # file in this folder
3851
```
3952

4053
## News
54+
- **New public 2024 and 2025** Snomed models were uploaded and made available 7. October 2025.
4155
- **MedCAT 2.0.0** was released 18. August 2025.
4256
<!-- - **Paper** van Es, B., Reteig, L.C., Tan, S.C. et al. [Negation detection in Dutch clinical texts: an evaluation of rule-based and machine learning methods](https://doi.org/10.1186/s12859-022-05130-x). BMC Bioinformatics 24, 10 (2023).
4357
- **New tool in the Cogstack ecosystem \[19. December 2022\]** [Foresight -- Deep Generative Modelling of Patient Timelines using Electronic Health Records](https://arxiv.org/abs/2212.08072)
@@ -74,10 +88,10 @@ pip install "medcat[spacy,meta-cat,deid,rel-cat,dict-ner]~=2.0.0" # for all of
7488

7589
## Demo
7690

77-
The MedCAT v2 demo web app is available [here](https://medcatv2.sites.er.kcl.ac.uk/).
91+
The MedCAT v2 demo web app is available [here](https://medcat.sites.er.kcl.ac.uk/).
7892

7993
## Tutorials
80-
A guide on how to use MedCAT v2 is available at [MedCATv2 Tutorials](https://github.com/CogStack/cogstack-nlp/tree/main/medcat-v2-tutorials).
94+
A guide on how to use MedCAT v2 is available at [MedCATv2 Tutorials](../medcat-v2-tutorials).
8195
However, the tutorials are a bit of a work in progress at this point in time.
8296

8397

0 commit comments

Comments
 (0)