api.models

Module Contents

Classes

ModelPack

ConceptDB

Vocabulary

MetaCATModel

Dataset

DatasetForm

Document

ProjectFields

Project

Entity

Relation

EntityRelation

AnnotatedEntity

MetaTaskValue

MetaTask

ProjectAnnotateEntitiesFields

Abstract class for all model fields for ProjectAnnotateEntities models.

ProjectAnnotateEntities

Class for any single ProjectAnnotateEntities model fields that should not be inherited by ProjectGroup

ProjectGroup

Abstract class for all model fields for ProjectAnnotateEntities models.

MetaAnnotation

ExportedProject

ProjectMetrics

Functions

auto_delete_cdb_file_on_delete(sender, instance, **kwargs)

auto_delete_vocab_file_on_delete(sender, instance, ...)

auto_delete_dataset_file_on_delete(sender, instance, ...)

_remove_file(instance, prop)

Attributes

STATUS_CHOICES

BOOL_CHOICES

cdb_name_validator

logger

api.models.STATUS_CHOICES = [(0, 'Not Validated'), (1, 'Validated')]
api.models.BOOL_CHOICES = [(0, 'False'), (1, 'True')]
api.models.cdb_name_validator
api.models.logger
class api.models.ModelPack

Bases: django.db.models.Model

name
model_pack
concept_db
vocab
meta_cats
create_time
last_modified
last_modified_by
save(*args, skip_load=False, **kwargs)
__str__()
class api.models.ConceptDB(*args, **kwargs)

Bases: django.db.models.Model

name
cdb_file
use_for_training
create_time
last_modified
last_modified_by
__init__(*args, **kwargs)
classmethod from_db(db, field_names, values)
save(*args, skip_load=False, **kwargs)
__str__()
class api.models.Vocabulary

Bases: django.db.models.Model

name
vocab_file
create_time
last_modified
last_modified_by
save(*args, skip_load=False, **kwargs)
__str__()
class api.models.MetaCATModel

Bases: django.db.models.Model

name
meta_cat_dir
get_or_create_meta_tasks_and_values(meta_cat)
Parameters:

meta_cat (medcat.components.addons.meta_cat.meta_cat.MetaCAT) –

save(*args, unpack_load_meta_cat_dir=False, **kwargs)
__str__()
class api.models.Dataset

Bases: django.db.models.Model

name
original_file
create_time
description
__str__()
class api.models.DatasetForm

Bases: django.forms.ModelForm

clean()
class api.models.Document

Bases: django.db.models.Model

class Meta
ordering = ['id']
name
create_time
last_modified
text
dataset
__str__()
class api.models.ProjectFields

Bases: django.db.models.Model

class Meta
abstract = True
PROJECT_STATUSES = [('A', 'Annotating'), ('D', 'Discontinued (Fail)'), ('C', 'Complete')]
name
description
dataset
create_time
last_modified
cuis
cuis_file
annotation_classification
meta_cat_predictions
project_locked
project_status
class api.models.Project

Bases: polymorphic.models.PolymorphicModel, ProjectFields

members
group
validated_documents
prepared_documents
__str__()
class api.models.Entity

Bases: django.db.models.Model

label
__str__()
class api.models.Relation

Bases: django.db.models.Model

class Meta
ordering = ['id']
label
__str__()
class api.models.EntityRelation

Bases: django.db.models.Model

class Meta
ordering = ['id']
user
project
document
relation
start_entity
end_entity
validated
create_time
last_modified
save(*args, **kwargs)
__str__()
class api.models.AnnotatedEntity

Bases: django.db.models.Model

class Meta
ordering = ['id']
user
project
document
entity
value
start_ind
end_ind
acc
comment
validated
correct
alternative
manually_created
deleted
killed
irrelevant
create_time
last_modified
save(*args, **kwargs)
__str__()
class api.models.MetaTaskValue

Bases: django.db.models.Model

class Meta
ordering = ['ordering', 'name']
name
ordering
__str__()
class api.models.MetaTask

Bases: django.db.models.Model

class Meta
ordering = ['ordering', 'name']
name
values
default
description
ordering
prediction_model
__str__()
class api.models.ProjectAnnotateEntitiesFields

Bases: django.db.models.Model

Abstract class for all model fields for ProjectAnnotateEntities models.

class Meta
abstract = True
concept_db
vocab
model_pack
cdb_search_filter
require_entity_validation
train_model_on_submit
add_new_entities
restrict_concept_lookup
terminate_available
irrelevant_available
deid_model_annotation
enable_entity_annotation_comments
tasks
relations
use_model_service
model_service_url
save(*args, **kwargs)
class api.models.ProjectAnnotateEntities

Bases: Project, ProjectAnnotateEntitiesFields

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

class api.models.ProjectGroup

Bases: ProjectFields, ProjectAnnotateEntitiesFields

Abstract class for all model fields for ProjectAnnotateEntities models.

administrators
annotators
cdb_search_filter
create_associated_projects
__str__()
class api.models.MetaAnnotation

Bases: django.db.models.Model

annotated_entity
meta_task
meta_task_value
acc
predicted_meta_task_value
validated
last_modified
save(*args, **kwargs)
__str__()
class api.models.ExportedProject

Bases: django.db.models.Model

trainer_export_file
import_project_name_suffix
members
cdb_id
vocab_id
modelpack_id
cdb_search_filter_id
set_validated_docs
__str__()
class api.models.ProjectMetrics

Bases: django.db.models.Model

report_name_generated
report_name
report
projects
__str__()
api.models.auto_delete_cdb_file_on_delete(sender, instance, **kwargs)
api.models.auto_delete_vocab_file_on_delete(sender, instance, **kwargs)
api.models.auto_delete_dataset_file_on_delete(sender, instance, **kwargs)
api.models._remove_file(instance, prop)
exception api.models.MedCATLoadException(message)

Bases: Exception

Common base class for all non-exit exceptions.

__init__(message)

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