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

.. py:module:: api.admin.models


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

Classes
~~~~~~~

.. autoapisummary::

   api.admin.models.ReportErrorModelAdminMixin
   api.admin.models.DatasetAdmin
   api.admin.models.ProjectAnnotateEntitiesAdmin
   api.admin.models.ProjectGroupAdmin
   api.admin.models.AnnotatedEntityAdmin
   api.admin.models.ConceptDBAdmin
   api.admin.models.VocabularyAdmin
   api.admin.models.ModelPackAdmin
   api.admin.models.MetaCATModelAdmin
   api.admin.models.MetaAnnotationAdmin
   api.admin.models.DocumentAdmin
   api.admin.models.ExportedProjectAdmin
   api.admin.models.ProjectMetricsAdmin




Attributes
~~~~~~~~~~

.. autoapisummary::

   api.admin.models._PROJECT_ANNO_ENTS_SETTINGS_FIELD_ORDER
   api.admin.models._PROJECT_FIELDS_ORDER


.. py:data:: _PROJECT_ANNO_ENTS_SETTINGS_FIELD_ORDER
   :value: ('concept_db', 'vocab', 'model_pack', 'cdb_search_filter', 'deid_model_annotation',...

   

.. py:data:: _PROJECT_FIELDS_ORDER
   :value: ('cuis', 'cuis_file', 'annotation_classification', 'project_locked', 'project_status')

   

.. py:class:: ReportErrorModelAdminMixin


   Mixin to catch all errors in the Django Admin and map them to user-visible errors.

   .. py:method:: changeform_view(request, object_id=None, form_url='', extra_context=None)



.. py:class:: DatasetAdmin


   Bases: :py:obj:`ReportErrorModelAdminMixin`, :py:obj:`django.contrib.admin.ModelAdmin`

   Mixin to catch all errors in the Django Admin and map them to user-visible errors.

   .. py:attribute:: model

      

   .. py:attribute:: form

      

   .. py:attribute:: list_display

      


.. py:class:: ProjectAnnotateEntitiesAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: actions

      

   .. py:attribute:: list_filter
      :value: ('members', 'project_status', 'project_locked', 'annotation_classification')

      

   .. py:attribute:: list_display
      :value: ['name']

      

   .. py:attribute:: fields

      

   .. py:method:: formfield_for_foreignkey(db_field, request, **kwargs)


   .. py:method:: formfield_for_manytomany(db_field, request, **kwargs)



.. py:class:: ProjectGroupAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:class:: Meta


      .. py:attribute:: model

         


   .. py:attribute:: model

      

   .. py:attribute:: list_display
      :value: ('name', 'description')

      

   .. py:attribute:: fields

      

   .. py:method:: get_form(request, obj=None, change=False, **kwargs)


   .. py:method:: _set_proj_from_group(proj, group, annotator, admins, cdb_search_filters, tasks, relations)


   .. py:method:: save_model(request, obj, form, change)



.. py:class:: AnnotatedEntityAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: list_display
      :value: ('user', 'project', 'entity', 'value', 'deleted', 'validated')

      

   .. py:attribute:: list_filter
      :value: ('user', 'project', 'deleted', 'validated')

      

   .. py:attribute:: model

      


.. py:class:: ConceptDBAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: actions

      

   .. py:attribute:: list_display
      :value: ('name', 'use_for_training', 'create_time', 'last_modified', 'last_modified_by')

      

   .. py:attribute:: fields
      :value: ('name', 'cdb_file', 'use_for_training')

      

   .. py:method:: save_model(request, obj, form, change)



.. py:class:: VocabularyAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: list_display
      :value: ('name', 'create_time', 'last_modified', 'last_modified_by')

      

   .. py:attribute:: fields
      :value: ('name', 'vocab_file', 'create_time', 'last_modified', 'last_modified_by')

      

   .. py:method:: save_model(request, obj, form, change)



.. py:class:: ModelPackAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: list_display
      :value: ('name', 'model_pack', 'concept_db', 'vocab', 'metacats')

      

   .. py:attribute:: fields
      :value: ['name', 'model_pack']

      

   .. py:method:: metacats(obj)


   .. py:method:: save_model(request, obj, form, change)



.. py:class:: MetaCATModelAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: list_display
      :value: ('name', 'meta_cat_dir')

      


.. py:class:: MetaAnnotationAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: list_display
      :value: ('annotated_entity', 'meta_task', 'meta_task_value', 'acc', 'predicted_meta_task_value',...

      

   .. py:attribute:: list_filter
      :value: ('meta_task', 'meta_task_value', 'predicted_meta_task_value', 'validated')

      


.. py:class:: DocumentAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: actions

      

   .. py:attribute:: list_filter
      :value: ('dataset',)

      

   .. py:attribute:: list_display
      :value: ['name', 'create_time', 'dataset', 'last_modified']

      


.. py:class:: ExportedProjectAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      


.. py:class:: ProjectMetricsAdmin


   Bases: :py:obj:`django.contrib.admin.ModelAdmin`

   .. py:attribute:: model

      

   .. py:attribute:: list_display
      :value: ('report_name', 'report_name_generated')

      

   .. py:attribute:: list_filter
      :value: ['projects']