medkit.core.annotation
======================

.. py:module:: medkit.core.annotation


Attributes
----------

.. autoapisummary::

   medkit.core.annotation.AnnotationType


Classes
-------

.. autoapisummary::

   medkit.core.annotation.Annotation


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

.. py:class:: Annotation

   Bases: :py:obj:`typing_extensions.Protocol`


   
   Base annotation protocol for any modality (text, audio, etc.).

   Annotations can be attached to :class:`~medkit.core.document.Document`
   objects and can contain :class:`~medkit.core.attribute.Attribute` objects.













   :Attributes:

       **uid** : str
           Unique identifier of the annotation

       **label** : str
           Label of the annotation, can be used to represent the "kind" of
           annotation. (ex: "sentence", "disease", etc)

       **keys** : set of str
           Pipeline output keys to which the segment belongs to (cf
           :class:`~medkit.core.pipeline.Pipeline`.)

       **attrs** : AttributeContainer
           Attributes of the annotation, stored in an
           :class:`~medkit.core.attribute_container.AttributeContainer` for easier
           access.


   ..
       !! processed by numpydoc !!

   .. py:attribute:: uid
      :type:  str


   .. py:attribute:: label
      :type:  str


   .. py:attribute:: keys
      :type:  set[str]


   .. py:attribute:: attrs
      :type:  medkit.core.attribute_container.AttributeContainer


.. py:data:: AnnotationType