app-heuristic-chyron-understanding/metadata.py at main · clamsproject/app-heuristic-chyron-understanding · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
"""
The purpose of this file is to define the metadata of the app with minimal imports.

DO NOT CHANGE the name of the file
"""

from mmif import DocumentTypes

from clams.app import ClamsApp
from clams.appmetadata import AppMetadata


# DO NOT CHANGE the function name
def appmetadata() -> AppMetadata:
    """
    Function to set app-metadata values and return it as an ``AppMetadata`` obj.
    Read these documentations before changing the code below
    - https://sdk.clams.ai/appmetadata.html metadata specification.
    - https://sdk.clams.ai/autodoc/clams.appmetadata.html python API


    :return: AppMetadata object holding all necessary information.
    """
    metadata = AppMetadata(
        name="Heuristic Chyron Understanding",
        description="Prototype to convert chyron text from docTR/Tesseract/LLaVA MMIF output"
                    "into a name and list of attributes.",
        app_license="Apache 2.0",
        identifier="heuristic-chyron-understanding",
        url="https://github.com/clamsproject/app-heuristic-chyron-understanding",
    )

    # I/O Spec
    in_doc = metadata.add_input(DocumentTypes.TextDocument)
    in_doc.add_description('Text content transcribed from video input by docTR/Tesseract/LLAVA.')
    out_doc = metadata.add_output(DocumentTypes.TextDocument,
                                  document='*', origin='*', provenance='derived', mime='application/json')
    out_doc.add_description('Reformatted chyron text. `document` property stores the ID of the original source '
                            '`VideoDocument`. `origin` property stores the ID of the original OCR `TextDocument` '
                            'annotation. Reformatted text is escaped JSON string with three fields: '
                            '`name-as-written`, `name-normalized`, and `attributes`. ')

    metadata.add_parameter(name='note4mode', default=False, type='boolean',
                           description='Boolean to set the app to run in "note-4" mode and to take the second line '
                                       '(if available) from the input text to be the `name-normalized` value. The '
                                       'default is false, which means the app will try to generate normalization from'
                                       '`name-as-written` (from the first line) value. ')

    return metadata


# DO NOT CHANGE the main block
if __name__ == '__main__':
    import sys
    metadata = appmetadata()
    for param in ClamsApp.universal_parameters:
        metadata.add_parameter(**param)
    sys.stdout.write(metadata.jsonify(pretty=True))