:py:mod:`medcat.datasets.medcat_annotations`
============================================
.. py:module:: medcat.datasets.medcat_annotations
Module Contents
---------------
Classes
~~~~~~~
.. autoapisummary::
medcat.datasets.medcat_annotations.MedCATAnnotationsConfig
medcat.datasets.medcat_annotations.MedCATAnnotations
Attributes
~~~~~~~~~~
.. autoapisummary::
medcat.datasets.medcat_annotations._CITATION
medcat.datasets.medcat_annotations._DESCRIPTION
.. py:data:: _CITATION
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""@ARTICLE{Kraljevic2021-ln,
title="Multi-domain clinical natural language processing with {MedCAT}: The Medical Concept Annotation Toolkit",
author="Kraljevic, Zeljko and Searle, Thomas and Shek, Anthony and Roguski, Lukasz and Noor, Kawsar and Bean, Daniel and Mascio, Aurelie and Zhu, Leilei and Folarin, Amos A and Roberts, Angus and Bendayan, Rebecca and Richardson, Mark P and Stewart, Robert and Shah, Anoop D and Wong, Wai Keong and Ibrahim, Zina and Teo, James T and Dobson, Richard J B",
journal="Artif. Intell. Med.",
volume=117,
pages="102083",
month=jul,
year=2021,
issn="0933-3657",
doi="10.1016/j.artmed.2021.102083"
}
"""
.. raw:: html
.. py:data:: _DESCRIPTION
:value: Multiline-String
.. raw:: html
Show Value
.. code-block:: python
"""Takes as input a pickled dict of annotated documents from MedCAT. The format should be:
{'document_id': {'entities': , ...}
Where entities is the output from medcat.get_entities(<...>)['entities']
"""
.. raw:: html
.. py:class:: MedCATAnnotationsConfig
Bases: :py:obj:`datasets.BuilderConfig`
BuilderConfig for MedCATAnnotations.
:param \*\*kwargs: keyword arguments forwarded to super.
.. py:class:: MedCATAnnotations(cache_dir = None, dataset_name = None, config_name = None, hash = None, base_path = None, info = None, features = None, token = None, use_auth_token='deprecated', repo_id = None, data_files = None, data_dir = None, storage_options = None, writer_batch_size = None, name='deprecated', **config_kwargs)
Bases: :py:obj:`datasets.GeneratorBasedBuilder`
MedCATAnnotations: Output of MedCAT
.. py:attribute:: BUILDER_CONFIGS
.. py:method:: _info()
Construct the DatasetInfo object. See `DatasetInfo` for details.
Warning: This function is only called once and the result is cached for all
following .info() calls.
:Returns: **info** -- (DatasetInfo) The dataset information
.. py:method:: _split_generators(dl_manager)
Returns SplitGenerators.
.. py:method:: _generate_examples(filepath)
This function returns the examples in the raw (text) form.