mmif.vocabulary module

Module contains Enum-like classes for CLAMS vocabulary.

mmif.vocabulary.ThingTypesBase[source]

alias of TypesBase

class mmif.vocabulary.ThingType(type_uri: str)[source]

Bases: TypesBase

This class contains the topmost CLAMS thing type defined in the spec version 1.1.0 as a class variable.

Thing = http://mmif.clams.ai/vocabulary/Thing/v1[source]
class mmif.vocabulary.ClamsTypesBase(type_uri, fuzzymode=True)[source]

Bases: TypesBase

Base class for CLAMS vocabulary types. Main This class adds handling of MMIF specification versions in initializer and comparators.

class mmif.vocabulary.AnnotationTypesBase(type_uri, fuzzymode=True)[source]

Bases: ClamsTypesBase

Inherit from this class to build your own custom annotation vocabularies.

class mmif.vocabulary.DocumentTypesBase(type_uri, fuzzymode=True)[source]

Bases: ClamsTypesBase

Inherit from this class to build your own custom document vocabularies.

class mmif.vocabulary.AnnotationTypes(type_uri, fuzzymode=True)[source]

Bases: AnnotationTypesBase

This class contains the CLAMS annotation types defined in the spec version 1.1.0 as class variables.

Alignment = http://mmif.clams.ai/vocabulary/Alignment/v1[source]
Annotation = http://mmif.clams.ai/vocabulary/Annotation/v6[source]
BoundingBox = http://mmif.clams.ai/vocabulary/BoundingBox/v5[source]
Chapter = http://mmif.clams.ai/vocabulary/Chapter/v6[source]
Interval = http://mmif.clams.ai/vocabulary/Interval/v5[source]
NamedEntity = http://mmif.clams.ai/vocabulary/NamedEntity/v1[source]
NounChunk = http://mmif.clams.ai/vocabulary/NounChunk/v1[source]
Paragraph = http://mmif.clams.ai/vocabulary/Paragraph/v1[source]
Polygon = http://mmif.clams.ai/vocabulary/Polygon/v5[source]
Region = http://mmif.clams.ai/vocabulary/Region/v5[source]
Relation = http://mmif.clams.ai/vocabulary/Relation/v5[source]
Sentence = http://mmif.clams.ai/vocabulary/Sentence/v1[source]
Span = http://mmif.clams.ai/vocabulary/Span/v5[source]
TimeFrame = http://mmif.clams.ai/vocabulary/TimeFrame/v6[source]
TimePoint = http://mmif.clams.ai/vocabulary/TimePoint/v5[source]
Token = http://mmif.clams.ai/vocabulary/Token/v1[source]
VerbChunk = http://mmif.clams.ai/vocabulary/VerbChunk/v1[source]
VideoObject = http://mmif.clams.ai/vocabulary/VideoObject/v5[source]
class mmif.vocabulary.DocumentTypes(type_uri, fuzzymode=True)[source]

Bases: DocumentTypesBase

This class contains the CLAMS document types defined in the spec version 1.1.0 as class variables.

AudioDocument = http://mmif.clams.ai/vocabulary/AudioDocument/v1[source]
Document = http://mmif.clams.ai/vocabulary/Document/v1[source]
ImageDocument = http://mmif.clams.ai/vocabulary/ImageDocument/v1[source]
TextDocument = http://mmif.clams.ai/vocabulary/TextDocument/v1[source]
VideoDocument = http://mmif.clams.ai/vocabulary/VideoDocument/v1[source]