Skip to content

docs: clarify entity outputs for core and en_ner models #562

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
LarytheLord wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify entity outputs for core and en_ner models #562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,11 @@ pip install CMD-V(to paste the copied URL)
| en_ner_bc5cdr_md | A spaCy NER model trained on the BC5CDR corpus. | [Download](https://s3-us-west-2.amazonaws.com/ai2-s2-scispacy/releases/v0.5.4/en_ner_bc5cdr_md-0.5.4.tar.gz)|
| en_ner_bionlp13cg_md | A spaCy NER model trained on the BIONLP13CG corpus. |[Download](https://s3-us-west-2.amazonaws.com/ai2-s2-scispacy/releases/v0.5.4/en_ner_bionlp13cg_md-0.5.4.tar.gz)|

### Model output notes

- `en_core_sci_sm`, `en_core_sci_md`, `en_core_sci_lg`, and `en_core_sci_scibert` include a **mention detector** trained on [MedMentions](https://aclanthology.org/P18-1010/), so detected spans are assigned the generic spaCy label `ENTITY` rather than fine-grained entity types.
- The `en_ner_*` models are corpus-specific biomedical NER models and produce label sets defined by their respective training corpora.


## Additional Pipeline Components

Expand Down Expand Up @@ -331,4 +336,3 @@ If you use ScispaCy in your research, please cite [ScispaCy: Fast and Robust Mod

ScispaCy is an open-source project developed by [the Allen Institute for Artificial Intelligence (AI2)](http://www.allenai.org).
AI2 is a non-profit institute with the mission to contribute to humanity through high-impact AI research and engineering.