:py:mod:`medcat.stats.mctexport`
================================

.. py:module:: medcat.stats.mctexport


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   medcat.stats.mctexport.MedCATTrainerExportAnnotation
   medcat.stats.mctexport.MedCATTrainerExportDocument
   medcat.stats.mctexport.MedCATTrainerExportProject
   medcat.stats.mctexport.MedCATTrainerExport



Functions
~~~~~~~~~

.. autoapisummary::

   medcat.stats.mctexport.iter_projects
   medcat.stats.mctexport.iter_docs
   medcat.stats.mctexport.iter_anns
   medcat.stats.mctexport.count_all_annotations
   medcat.stats.mctexport.count_all_docs
   medcat.stats.mctexport.get_nr_of_annotations



Attributes
~~~~~~~~~~

.. autoapisummary::

   medcat.stats.mctexport.MedCATTrainerExportProjectInfo


.. py:class:: MedCATTrainerExportAnnotation


   Bases: :py:obj:`typing_extensions.TypedDict`

   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)

   .. py:attribute:: start
      :type: int

      

   .. py:attribute:: end
      :type: int

      

   .. py:attribute:: cui
      :type: str

      

   .. py:attribute:: value
      :type: str

      


.. py:class:: MedCATTrainerExportDocument


   Bases: :py:obj:`typing_extensions.TypedDict`

   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: id
      :type: Any

      

   .. py:attribute:: last_modified
      :type: str

      

   .. py:attribute:: text
      :type: str

      

   .. py:attribute:: annotations
      :type: List[MedCATTrainerExportAnnotation]

      


.. py:class:: MedCATTrainerExportProject


   Bases: :py:obj:`typing_extensions.TypedDict`

   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: id
      :type: Any

      

   .. py:attribute:: cuis
      :type: str

      

   .. py:attribute:: tuis
      :type: Optional[str]

      

   .. py:attribute:: documents
      :type: List[MedCATTrainerExportDocument]

      


.. py:data:: MedCATTrainerExportProjectInfo

   The project name, project ID, CUIs str, and TUIs str

.. py:class:: MedCATTrainerExport


   Bases: :py:obj:`typing_extensions.TypedDict`

   dict() -> new empty dictionary
   dict(mapping) -> new dictionary initialized from a mapping object's
       (key, value) pairs
   dict(iterable) -> new dictionary initialized as if via:
       d = {}
       for k, v in iterable:
           d[k] = v
   dict(**kwargs) -> new dictionary initialized with the name=value pairs
       in the keyword argument list.  For example:  dict(one=1, two=2)

   .. py:attribute:: projects
      :type: List[MedCATTrainerExportProject]

      


.. py:function:: iter_projects(export)


.. py:function:: iter_docs(export)


.. py:function:: iter_anns(export)


.. py:function:: count_all_annotations(export)


.. py:function:: count_all_docs(export)


.. py:function:: get_nr_of_annotations(doc)