Skip to content

Commit d7c7d0a

Browse files
authored
docs(medcat): CU-869b2fcrc Update migration guide (#214)
* CU-869b2fcrc: Update docs with distinction of cogstack-es and medcat-scripts for v2 * CU-869b2fcrc: Add embedding linker to migration guide * CU-869b2fcrc: Add v2 trainer link * CU-869b2fcrc: Add trainer and WWC changes to FAQ * CU-869b2fcrc: Specify scripts-downloader for medcat v2.3.0 and later * CU-869b2fcrc: Fix optional extra in installation instructions for cogstack-es * CU-869b2fcrc: Fix typo
1 parent 4499501 commit d7c7d0a

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

cogstack-es/ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ This project is responsible for logging in and performing a search for Elasticse
66

77
This package is distributed through PyPI and can be installed using one of:
88
```
9-
pip install cogstack-es[ES9] # For Elasticsearch 9
10-
pip install cogstack-es[ES8] # For Elasticsearch 8
11-
pip install cogstack-es[OS] # For Opensearch
9+
pip install "cogstack-es[ES9]" # For Elasticsearch 9
10+
pip install "cogstack-es[ES8]" # For Elasticsearch 8
11+
pip install "cogstack-es[OS]" # For Opensearch
1212
```
1313

1414
PS:

medcat-v2/docs/migration_guide_v2.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ Here's a list of the additional features you can opt for with what they're used
7070
| Transformer NER | `deid` | Enables transformer-based NER, primarily used for de-identification models |
7171
| Relation Extraction | `rel-cat` | Adds support for extracting relations between entities |
7272
| Dictionary NER | `dict-ner` | Example dictionary NER module (experimental and rarely needed) |
73+
| Embedding linker | `embed-linker` | Linker that uses more sophisiticated context embeddings for linking |
7374

7475
## Summary of Changes
7576

@@ -122,15 +123,12 @@ The v2 tutorials are available [here](https://github.com/CogStack/cogstack-nlp/t
122123
## Updated `working_with_cogstack` scripts
123124

124125
The `working_with_cogstack` scripts have also been upgraded to support v2.
125-
The changes are currently in [this PR](https://github.com/CogStack/working_with_cogstack/pull/20).
126-
They have not yet been merged in to the `main` branch but will be in the near future.
127-
At that point, there will probably be a separate branch to keep track of v1-specific scripts.
126+
However, they have been split into `cogstack-es` which lives [here](https://github.com/CogStack/cogstack-nlp/tree/main/cogstack-es), but notably also available on PyPI (i.e `pip install "cogstack-es[ES9]"`); and `medcat-scripts` available [here](https://github.com/CogStack/cogstack-nlp/tree/main/medcat-scripts) which can be fetched using `python -m medcat download-scripts` (in v2.3.0 onwards).
128127

129128
## MedCATtrainer
130129

131-
MedCATtrainer has been modified to work with v2 in [this PR](https://github.com/CogStack/MedCATtrainer/pull/253).
132-
However, as of writing, this change has not yet been merged in or been released.
133-
The v2-supporting release will most likely be released as **v3** on the trainer side.
130+
MedCATtrainer has been modified to work with v2 in [here](https://github.com/CogStack/cogstack-nlp/tree/main/medcat-trainer).
131+
The v2-supporting releases are those from **v3** on the trainer side.
134132

135133
## Feedback welcome!
136134

@@ -181,12 +179,12 @@ A: Training now uses a dedicated `medcat.trainer.Trainer` class. See tutorials a
181179

182180
**Q: Are v1 `working_with_cogstack` scripts still supported?**
183181

184-
A: No. Many will break due to internal changes. Please refer to the new scripts in the [relevant branch](https://github.com/CogStack/working_with_cogstack/pull/20).
182+
A: No. You should use [medcat scripts](https://github.com/CogStack/cogstack-nlp/tree/main/medcat-scripts) and [cogstack-es](https://github.com/CogStack/cogstack-nlp/tree/main/cogstack-es) by doing `python -m medcat download-scripts` (in v2.3.0 onwards) and `pip install "cogstack-es[ES9]"`.
185183

186184

187185
**Q: Does MedCATtrainer work out of the box for v2?**
188186

189-
A: No. While the [changes have been ported](https://github.com/CogStack/MedCATtrainer/pull/253), there is currently no release for these changes and it is unlikely to already be spun up yet. But it will be soon.
187+
A: Yes. Trainer versions from v3 onwards will work natively with v2.
190188

191189

192190
**Q: Does `medcat-service` work for serving a model?**

0 commit comments

Comments
 (0)