:py:mod:`api.models`
====================

.. py:module:: api.models


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

Classes
~~~~~~~

.. autoapisummary::

   api.models.ModelPack
   api.models.ConceptDB
   api.models.Vocabulary
   api.models.MetaCATModel
   api.models.Dataset
   api.models.DatasetForm
   api.models.Document
   api.models.ProjectFields
   api.models.Project
   api.models.Entity
   api.models.Relation
   api.models.EntityRelation
   api.models.AnnotatedEntity
   api.models.MetaTaskValue
   api.models.MetaTask
   api.models.ProjectAnnotateEntitiesFields
   api.models.ProjectAnnotateEntities
   api.models.ProjectGroup
   api.models.MetaAnnotation
   api.models.ExportedProject
   api.models.ProjectMetrics



Functions
~~~~~~~~~

.. autoapisummary::

   api.models.auto_delete_cdb_file_on_delete
   api.models.auto_delete_vocab_file_on_delete
   api.models.auto_delete_dataset_file_on_delete
   api.models._remove_file



Attributes
~~~~~~~~~~

.. autoapisummary::

   api.models.STATUS_CHOICES
   api.models.BOOL_CHOICES
   api.models.cdb_name_validator
   api.models.logger


.. py:data:: STATUS_CHOICES
   :value: [(0, 'Not Validated'), (1, 'Validated')]

   

.. py:data:: BOOL_CHOICES
   :value: [(0, 'False'), (1, 'True')]

   

.. py:data:: cdb_name_validator

   

.. py:data:: logger

   

.. py:class:: ModelPack


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: name

      

   .. py:attribute:: model_pack

      

   .. py:attribute:: concept_db

      

   .. py:attribute:: vocab

      

   .. py:attribute:: meta_cats

      

   .. py:attribute:: create_time

      

   .. py:attribute:: last_modified

      

   .. py:attribute:: last_modified_by

      

   .. py:method:: save(*args, skip_load=False, **kwargs)


   .. py:method:: __str__()



.. py:class:: ConceptDB(*args, **kwargs)


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: name

      

   .. py:attribute:: cdb_file

      

   .. py:attribute:: use_for_training

      

   .. py:attribute:: create_time

      

   .. py:attribute:: last_modified

      

   .. py:attribute:: last_modified_by

      

   .. py:method:: __init__(*args, **kwargs)


   .. py:method:: from_db(db, field_names, values)
      :classmethod:


   .. py:method:: save(*args, skip_load=False, **kwargs)


   .. py:method:: __str__()



.. py:class:: Vocabulary


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: name

      

   .. py:attribute:: vocab_file

      

   .. py:attribute:: create_time

      

   .. py:attribute:: last_modified

      

   .. py:attribute:: last_modified_by

      

   .. py:method:: save(*args, skip_load=False, **kwargs)


   .. py:method:: __str__()



.. py:class:: MetaCATModel


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: name

      

   .. py:attribute:: meta_cat_dir

      

   .. py:method:: get_or_create_meta_tasks_and_values(meta_cat)


   .. py:method:: save(*args, unpack_load_meta_cat_dir=False, **kwargs)


   .. py:method:: __str__()



.. py:class:: Dataset


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: name

      

   .. py:attribute:: original_file

      

   .. py:attribute:: create_time

      

   .. py:attribute:: description

      

   .. py:method:: __str__()



.. py:class:: DatasetForm


   Bases: :py:obj:`django.forms.ModelForm`

   .. py:method:: clean()



.. py:class:: Document


   Bases: :py:obj:`django.db.models.Model`

   .. py:class:: Meta


      .. py:attribute:: ordering
         :value: ['id']

         


   .. py:attribute:: name

      

   .. py:attribute:: create_time

      

   .. py:attribute:: last_modified

      

   .. py:attribute:: text

      

   .. py:attribute:: dataset

      

   .. py:method:: __str__()



.. py:class:: ProjectFields


   Bases: :py:obj:`django.db.models.Model`

   .. py:class:: Meta


      .. py:attribute:: abstract
         :value: True

         


   .. py:attribute:: PROJECT_STATUSES
      :value: [('A', 'Annotating'), ('D', 'Discontinued (Fail)'), ('C', 'Complete')]

      

   .. py:attribute:: name

      

   .. py:attribute:: description

      

   .. py:attribute:: dataset

      

   .. py:attribute:: annotation_guideline_link

      

   .. py:attribute:: create_time

      

   .. py:attribute:: last_modified

      

   .. py:attribute:: cuis

      

   .. py:attribute:: cuis_file

      

   .. py:attribute:: annotation_classification

      

   .. py:attribute:: meta_cat_predictions

      

   .. py:attribute:: project_locked

      

   .. py:attribute:: project_status

      


.. py:class:: Project


   Bases: :py:obj:`polymorphic.models.PolymorphicModel`, :py:obj:`ProjectFields`

   .. py:attribute:: members

      

   .. py:attribute:: group

      

   .. py:attribute:: validated_documents

      

   .. py:attribute:: prepared_documents

      

   .. py:method:: __str__()



.. py:class:: Entity


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: label

      

   .. py:method:: __str__()



.. py:class:: Relation


   Bases: :py:obj:`django.db.models.Model`

   .. py:class:: Meta


      .. py:attribute:: ordering
         :value: ['id']

         


   .. py:attribute:: label

      

   .. py:method:: __str__()



.. py:class:: EntityRelation


   Bases: :py:obj:`django.db.models.Model`

   .. py:class:: Meta


      .. py:attribute:: ordering
         :value: ['id']

         


   .. py:attribute:: user

      

   .. py:attribute:: project

      

   .. py:attribute:: document

      

   .. py:attribute:: relation

      

   .. py:attribute:: start_entity

      

   .. py:attribute:: end_entity

      

   .. py:attribute:: validated

      

   .. py:attribute:: create_time

      

   .. py:attribute:: last_modified

      

   .. py:method:: save(*args, **kwargs)


   .. py:method:: __str__()



.. py:class:: AnnotatedEntity


   Bases: :py:obj:`django.db.models.Model`

   .. py:class:: Meta


      .. py:attribute:: ordering
         :value: ['id']

         


   .. py:attribute:: user

      

   .. py:attribute:: project

      

   .. py:attribute:: document

      

   .. py:attribute:: entity

      

   .. py:attribute:: value

      

   .. py:attribute:: start_ind

      

   .. py:attribute:: end_ind

      

   .. py:attribute:: acc

      

   .. py:attribute:: comment

      

   .. py:attribute:: validated

      

   .. py:attribute:: correct

      

   .. py:attribute:: alternative

      

   .. py:attribute:: manually_created

      

   .. py:attribute:: deleted

      

   .. py:attribute:: killed

      

   .. py:attribute:: irrelevant

      

   .. py:attribute:: create_time

      

   .. py:attribute:: last_modified

      

   .. py:method:: save(*args, **kwargs)


   .. py:method:: __str__()



.. py:class:: MetaTaskValue


   Bases: :py:obj:`django.db.models.Model`

   .. py:class:: Meta


      .. py:attribute:: ordering
         :value: ['ordering', 'name']

         


   .. py:attribute:: name

      

   .. py:attribute:: ordering

      

   .. py:method:: __str__()



.. py:class:: MetaTask


   Bases: :py:obj:`django.db.models.Model`

   .. py:class:: Meta


      .. py:attribute:: ordering
         :value: ['ordering', 'name']

         


   .. py:attribute:: name

      

   .. py:attribute:: values

      

   .. py:attribute:: default

      

   .. py:attribute:: description

      

   .. py:attribute:: ordering

      

   .. py:attribute:: prediction_model

      

   .. py:method:: __str__()



.. py:class:: ProjectAnnotateEntitiesFields


   Bases: :py:obj:`django.db.models.Model`

   Abstract class for all model fields for ProjectAnnotateEntities models.

   .. py:class:: Meta


      .. py:attribute:: abstract
         :value: True

         


   .. py:attribute:: concept_db

      

   .. py:attribute:: vocab

      

   .. py:attribute:: model_pack

      

   .. py:attribute:: cdb_search_filter

      

   .. py:attribute:: require_entity_validation

      

   .. py:attribute:: train_model_on_submit

      

   .. py:attribute:: add_new_entities

      

   .. py:attribute:: restrict_concept_lookup

      

   .. py:attribute:: terminate_available

      

   .. py:attribute:: irrelevant_available

      

   .. py:attribute:: deid_model_annotation

      

   .. py:attribute:: enable_entity_annotation_comments

      

   .. py:attribute:: tasks

      

   .. py:attribute:: relations

      

   .. py:attribute:: use_model_service

      

   .. py:attribute:: model_service_url

      

   .. py:method:: save(*args, **kwargs)



.. py:class:: ProjectAnnotateEntities


   Bases: :py:obj:`Project`, :py:obj:`ProjectAnnotateEntitiesFields`

   Class for any single ProjectAnnotateEntities model fields that should not be inherited by ProjectGroup
   In practise its unlikely further fields are needed.


.. py:class:: ProjectGroup


   Bases: :py:obj:`ProjectFields`, :py:obj:`ProjectAnnotateEntitiesFields`

   Abstract class for all model fields for ProjectAnnotateEntities models.

   .. py:attribute:: administrators

      

   .. py:attribute:: annotators

      

   .. py:attribute:: cdb_search_filter

      

   .. py:attribute:: create_associated_projects

      

   .. py:method:: __str__()



.. py:class:: MetaAnnotation


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: annotated_entity

      

   .. py:attribute:: meta_task

      

   .. py:attribute:: meta_task_value

      

   .. py:attribute:: acc

      

   .. py:attribute:: predicted_meta_task_value

      

   .. py:attribute:: validated

      

   .. py:attribute:: last_modified

      

   .. py:method:: save(*args, **kwargs)


   .. py:method:: __str__()



.. py:class:: ExportedProject


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: trainer_export_file

      

   .. py:attribute:: import_project_name_suffix

      

   .. py:attribute:: members

      

   .. py:attribute:: cdb_id

      

   .. py:attribute:: vocab_id

      

   .. py:attribute:: modelpack_id

      

   .. py:attribute:: cdb_search_filter_id

      

   .. py:attribute:: set_validated_docs

      

   .. py:method:: __str__()



.. py:class:: ProjectMetrics


   Bases: :py:obj:`django.db.models.Model`

   .. py:attribute:: report_name_generated

      

   .. py:attribute:: report_name

      

   .. py:attribute:: report

      

   .. py:attribute:: projects

      

   .. py:method:: __str__()



.. py:function:: auto_delete_cdb_file_on_delete(sender, instance, **kwargs)


.. py:function:: auto_delete_vocab_file_on_delete(sender, instance, **kwargs)


.. py:function:: auto_delete_dataset_file_on_delete(sender, instance, **kwargs)


.. py:function:: _remove_file(instance, prop)


.. py:exception:: MedCATLoadException(message)


   Bases: :py:obj:`Exception`

   Common base class for all non-exit exceptions.

   .. py:method:: __init__(message)

      Initialize self.  See help(type(self)) for accurate signature.