mmif package

mmif.get_mmif_json_schema()

mmif.find_all_modules(pkgname)

mmif.prep_argparser_and_subcmds()

mmif.cli()

Subpackages

• mmif.serialize package
  • Annotation
    • Annotation.aligned_to_by()
    • Annotation.get_all_aligned()
    • Annotation.is_type()
    • Annotation.at_type
    • Annotation.parent
    • Annotation.id
    • Annotation.long_id
    • Annotation.check_prop_value_is_simple_enough()
    • Annotation.add_property()
    • Annotation.get()
    • Annotation.get_property()
    • Annotation.is_document()
  • AnnotationProperties
  • Document
    • Document.add_property()
    • Document.get()
    • Document.get_property()
    • Document.text_language
    • Document.text_value
    • Document.location
    • Document.location_scheme()
    • Document.location_address()
    • Document.location_path()
  • DocumentProperties
    • DocumentProperties.text_language
    • DocumentProperties.text_value
    • DocumentProperties.location
    • DocumentProperties.location_scheme()
    • DocumentProperties.location_address()
    • DocumentProperties.location_path()
    • DocumentProperties.location_path_resolved()
    • DocumentProperties.location_path_literal()
  • Text
    • Text.lang
    • Text.value
  • Mmif
    • Mmif.validate()
    • Mmif.serialize()
    • Mmif.generate_capital_annotations()
    • Mmif.sanitize()
    • Mmif.new_view_id()
    • Mmif.new_view()
    • Mmif.add_view()
    • Mmif.add_document()
    • Mmif.get_documents_in_view()
    • Mmif.get_documents_by_type()
    • Mmif.get_documents_by_app()
    • Mmif.get_documents_by_property()
    • Mmif.get_documents_locations()
    • Mmif.get_document_location()
    • Mmif.get_document_by_id()
    • Mmif.get_view_by_id()
    • Mmif.get_alignments()
    • Mmif.get_views_for_document()
    • Mmif.get_all_views_with_error()
    • Mmif.get_views_with_error()
    • Mmif.get_all_views_contain()
    • Mmif.get_views_contain()
    • Mmif.get_view_with_error()
    • Mmif.get_last_error()
    • Mmif.get_view_contains()
    • Mmif.get_annotations_between_time()
    • Mmif.get_start()
    • Mmif.get_end()
  • View
    • View.new_contain()
    • View.new_annotation()
    • View.add_annotation()
    • View.new_textdocument()
    • View.add_document()
    • View.get_annotations()
    • View.get_annotation_by_id()
    • View.get_documents()
    • View.get_document_by_id()
    • View.set_error()
    • View.get_error()
    • View.has_error()
    • View.has_warnings()
  • ViewMetadata
    • ViewMetadata.has_error()
    • ViewMetadata.has_warnings()
    • ViewMetadata.get_error_as_text()
    • ViewMetadata.new_contain()
    • ViewMetadata.add_contain()
    • ViewMetadata.add_app_configuration()
    • ViewMetadata.get_app_configuration()
    • ViewMetadata.add_parameters()
    • ViewMetadata.add_parameter()
    • ViewMetadata.get_parameter()
    • ViewMetadata.set_error()
    • ViewMetadata.add_warnings()
    • ViewMetadata.emtpy_warnings()
  • Contain
  • Submodules
  • mmif.serialize.annotation module
    • Annotation
      • Annotation.aligned_to_by()
      • Annotation.get_all_aligned()
      • Annotation.is_type()
      • Annotation.at_type
      • Annotation.parent
      • Annotation.id
      • Annotation.long_id
      • Annotation.check_prop_value_is_simple_enough()
      • Annotation.add_property()
      • Annotation.get()
      • Annotation.get_property()
      • Annotation.is_document()
    • AnnotationProperties
    • Document
      • Document.add_property()
      • Document.get()
      • Document.get_property()
      • Document.text_language
      • Document.text_value
      • Document.location
      • Document.location_scheme()
      • Document.location_address()
      • Document.location_path()
    • DocumentProperties
      • DocumentProperties.text_language
      • DocumentProperties.text_value
      • DocumentProperties.location
      • DocumentProperties.location_scheme()
      • DocumentProperties.location_address()
      • DocumentProperties.location_path()
      • DocumentProperties.location_path_resolved()
      • DocumentProperties.location_path_literal()
    • Text
      • Text.lang
      • Text.value
  • mmif.serialize.mmif module
    • Mmif
      • Mmif.validate()
      • Mmif.serialize()
      • Mmif.generate_capital_annotations()
      • Mmif.sanitize()
      • Mmif.new_view_id()
      • Mmif.new_view()
      • Mmif.add_view()
      • Mmif.add_document()
      • Mmif.get_documents_in_view()
      • Mmif.get_documents_by_type()
      • Mmif.get_documents_by_app()
      • Mmif.get_documents_by_property()
      • Mmif.get_documents_locations()
      • Mmif.get_document_location()
      • Mmif.get_document_by_id()
      • Mmif.get_view_by_id()
      • Mmif.get_alignments()
      • Mmif.get_views_for_document()
      • Mmif.get_all_views_with_error()
      • Mmif.get_views_with_error()
      • Mmif.get_all_views_contain()
      • Mmif.get_views_contain()
      • Mmif.get_view_with_error()
      • Mmif.get_last_error()
      • Mmif.get_view_contains()
      • Mmif.get_annotations_between_time()
      • Mmif.get_start()
      • Mmif.get_end()
  • mmif.serialize.model module
    • MmifObject
      • MmifObject.view_prefix
      • MmifObject.id_delimiter
      • MmifObject.reserved_names
      • MmifObject.disallow_additional_properties()
      • MmifObject.set_additional_property()
      • MmifObject.serialize()
      • MmifObject.is_empty()
      • MmifObject.deserialize()
      • MmifObject.get()
    • MmifObjectEncoder
      • MmifObjectEncoder.default()
    • DataList
      • DataList.deserialize()
      • DataList.get()
      • DataList.append()
      • DataList.empty()
    • DataDict
      • DataDict.get()
      • DataDict.update()
      • DataDict.items()
      • DataDict.keys()
      • DataDict.values()
      • DataDict.empty()
  • mmif.serialize.view module
    • View
      • View.new_contain()
      • View.new_annotation()
      • View.add_annotation()
      • View.new_textdocument()
      • View.add_document()
      • View.get_annotations()
      • View.get_annotation_by_id()
      • View.get_documents()
      • View.get_document_by_id()
      • View.set_error()
      • View.get_error()
      • View.has_error()
      • View.has_warnings()
    • ViewMetadata
      • ViewMetadata.has_error()
      • ViewMetadata.has_warnings()
      • ViewMetadata.get_error_as_text()
      • ViewMetadata.new_contain()
      • ViewMetadata.add_contain()
      • ViewMetadata.add_app_configuration()
      • ViewMetadata.get_app_configuration()
      • ViewMetadata.add_parameters()
      • ViewMetadata.add_parameter()
      • ViewMetadata.get_parameter()
      • ViewMetadata.set_error()
      • ViewMetadata.add_warnings()
      • ViewMetadata.emtpy_warnings()
    • Contain
• mmif.utils package
  • Subpackages
    • mmif.utils.cli package
      • open_cli_io_arg()
      • generate_model_summary()
      • Submodules
      • mmif.utils.cli.describe module
      • mmif.utils.cli.rewind module
      • mmif.utils.cli.source module
      • mmif.utils.cli.summarize module
    • mmif.utils.summarizer package
      • argparser()
      • pp_args()
      • main()
      • Submodules
      • mmif.utils.summarizer.config module
      • mmif.utils.summarizer.graph module
      • mmif.utils.summarizer.nodes module
      • mmif.utils.summarizer.summary module
      • mmif.utils.summarizer.utils module
  • Submodules
  • mmif.utils.sequence_helper module
    • smooth_outlying_short_intervals()
    • validate_labelset()
    • build_label_remapper()
    • build_score_lists()
  • mmif.utils.text_document_helper module
    • slice_text()
  • mmif.utils.timeunit_helper module
    • convert()
  • mmif.utils.video_document_helper module
    • SamplingMode
      • SamplingMode.REPRESENTATIVES
      • SamplingMode.SINGLE
      • SamplingMode.ALL
    • capture()
    • get_framerate()
    • extract_frames_as_images()
    • get_mid_framenum()
    • extract_mid_frame()
    • get_representative_framenums()
    • get_representative_framenum()
    • extract_representative_frame()
    • extract_target_frames()
    • extract_frames_by_mode()
    • sample_frames()
    • get_annotation_property()
    • convert_timepoint()
    • convert_timeframe()
    • framenum_to_second()
    • framenum_to_millisecond()
    • second_to_framenum()
    • millisecond_to_framenum()
  • mmif.utils.workflow_helper module
    • group_views_by_app()
    • generate_param_hash()
    • generate_workflow_identifier()
    • SingleMmifStats
      • SingleMmifStats.annotation_count_by_type
      • SingleMmifStats.app_count
      • SingleMmifStats.empty_views
      • SingleMmifStats.error_views
      • SingleMmifStats.warning_views
    • AppProfiling
      • AppProfiling.running_time_ms
    • AppExecution
      • AppExecution.annotation_count_by_type
      • AppExecution.app
      • AppExecution.app_configuration
      • AppExecution.app_profiling
      • AppExecution.view_ids
    • SingleMmifDesc
      • SingleMmifDesc.apps
      • SingleMmifDesc.stats
      • SingleMmifDesc.workflow_id
    • describe_single_mmif()
    • AppProfilingStats
      • AppProfilingStats.avg_running_time_ms
      • AppProfilingStats.max_running_time_ms
      • AppProfilingStats.min_running_time_ms
      • AppProfilingStats.stdev_running_time_ms
    • WorkflowAppExecution
      • WorkflowAppExecution.app
      • WorkflowAppExecution.app_configuration
      • WorkflowAppExecution.app_profiling
    • WorkflowCollectionEntry
      • WorkflowCollectionEntry.apps
      • WorkflowCollectionEntry.mmif_count
      • WorkflowCollectionEntry.mmifs
      • WorkflowCollectionEntry.workflow_id
    • MmifCountByStatus
      • MmifCountByStatus.invalid
      • MmifCountByStatus.successful
      • MmifCountByStatus.total
      • MmifCountByStatus.with_errors
      • MmifCountByStatus.with_warnings
    • CollectionMmifDesc
      • CollectionMmifDesc.annotation_count_by_type
      • CollectionMmifDesc.mmif_count_by_status
      • CollectionMmifDesc.workflows
    • describe_mmif_collection()
• mmif.vocabulary package
  • Submodules
  • mmif.vocabulary.annotation_types module
    • AnnotationTypes
      • AnnotationTypes.Annotation
      • AnnotationTypes.Region
      • AnnotationTypes.TimePoint
      • AnnotationTypes.Interval
      • AnnotationTypes.Span
      • AnnotationTypes.Token
      • AnnotationTypes.Sentence
      • AnnotationTypes.Paragraph
      • AnnotationTypes.NamedEntity
      • AnnotationTypes.NounChunk
      • AnnotationTypes.VerbChunk
      • AnnotationTypes.TimeFrame
      • AnnotationTypes.Chapter
      • AnnotationTypes.Polygon
      • AnnotationTypes.BoundingBox
      • AnnotationTypes.VideoObject
      • AnnotationTypes.Relation
      • AnnotationTypes.Alignment
  • mmif.vocabulary.base_types module
    • TypesBase
      • TypesBase.base_uri
      • TypesBase.shortname
      • TypesBase.old_lapps_type_shortnames
      • TypesBase.fuzzy_eq
      • TypesBase.parse_names()
      • TypesBase.attype_iri_isdocument()
      • TypesBase.from_str()
      • TypesBase.get_prefix()
      • TypesBase.set_prefix()
    • ThingTypesBase
    • ClamsTypesBase
      • ClamsTypesBase.version
      • ClamsTypesBase.dev_version
      • ClamsTypesBase.parse_names()
      • ClamsTypesBase.normalize_attype_vers()
    • AnnotationTypesBase
    • DocumentTypesBase
    • ThingType
      • ThingType.Thing
  • mmif.vocabulary.document_types module
    • DocumentTypes
      • DocumentTypes.Document
      • DocumentTypes.VideoDocument
      • DocumentTypes.AudioDocument
      • DocumentTypes.ImageDocument
      • DocumentTypes.TextDocument