a b/docs/source/index.rst
1
MedaCy Documentation
2
====================
3
For the latest updates, please see the project on `github <https://github.com/NLPatVCU/medaCy>`_.
4
5
MedaCy is a medical text mining framework built over spaCy to facilitate the engineering, training and application
6
of machine learning models for medical information extraction.
7
8
To confront the unique challenges posed by medical text
9
medaCy provides interfaces to medical ontologies such as `Metamap <https://metamap.nlm.nih.gov/>`_ allowing their
10
integration into text mining workflows. Additional help, examples and tutorials can be found in the examples section
11
of the `repository <https://github.com/NLPatVCU/medaCy/tree/master/examples>`_.
12
13
MedaCy does not officially support non-unix based operating systems (however we have found most functionality works on Windows).
14
15
Trained Models
16
--------------
17
A complete listing of trained models can be found `here <https://github.com/NLPatVCU/medaCy/tree/master/examples#utilizing-pre-trained-ner-models>`_.
18
19
20
Datasets
21
--------
22
MedaCy implements a Dataset functionality that loosely wraps a working directory to manage and version training data.
23
See more in the `examples <https://github.com/NLPatVCU/medaCy/tree/master/examples>`_.
24
25
Contents
26
--------
27
28
.. toctree::
29
    :maxdepth: 3
30
31
    medacy