Skip to content

cocs(medcat-scripts): CU-869c25ux2 Document scripts download through medcat lib #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mart-r wants to merge 2 commits into
base: main
Choose a base branch
from
Open

cocs(medcat-scripts): CU-869c25ux2 Document scripts download through medcat lib #320

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b3337a
CU-869c25ux2: Add link to tutorials to README
mart-r Feb 6, 2026
c040d1a
CU-869c25ux2: Add documentation to use medcat to download medcat-scripts
mart-r Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions medcat-scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@
This project contains the relevant tools and notebooks to help users work with MedCAT models.
This includes instructions on finetuning models in an unsupervised or supervised manner as well as evaluating MedCATtrainer exports and run models on data.

Some tutorials in [medcat-v2-tutorials](../medcat-v2-tutorials/) may also be of help.

# Setup

To gain access to these scripts you simply:
```
git clone https://github.com/CogStack/cogstack-nlp.git
cd cogstack-nlp/medcat-scripts
```
OR (in `medcat>=2.3.0`) you can have `medcat` download the appropriate scripts for you by running:
```
# NOTE: by default this gets installed to your local directory, but a path can be provided
python -m medcat download-scripts
```
You may subsequently need to install the relevant requirements
```
python -m pip install -r requirements.txt
Expand Down