metadata.py

"""
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, AnnotationTypes

from clams.app import ClamsApp
from clams.appmetadata import AppMetadata
from lapps.discriminators import Uri


# 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.
    """

    # first set up some basic information
    metadata = AppMetadata(
        name="Dbpedia Spotlight Wrapper",
        description="Apply named entity linking to all text documents in a MMIF file.",  # briefly describe what the purpose and features of the app
        app_license="Apache 2.0",  # short name for a software license like MIT, Apache2, GPL, etc.
        identifier="dbpedia-spotlight-wrapper",  # should be a single string without whitespaces. If you don't intent to publish this app to the CLAMS app-directory, please use a full IRI format.
        url="https://github.com/clamsproject/app-dbpedia-spotlight-wrapper",  # a website where the source code and full documentation of the app is hosted, if you are on the CLAMS team, see ``.github/README.md`` file in this directory.
        # use the following if this app is a wrapper of an existing computational analysis tool
        # (it is very important to pinpoint the primary analyzer version for reproducibility)
        analyzer_version='daf5309',
        # if the analyzer is a python app, and it's specified in the requirements.txt
        # this trick can also be useful (replace ANALYZER_NAME with the pypi dist name)
        # analyzer_version=[l.strip().rsplit('==')[-1] for l in open('requirements.txt').readlines() if re.match(r'^ANALYZER_NAME==', l)][0],
        analyzer_license="Apache 2.0",  # short name for a software license
    )
    # and then add I/O specifications: an app must have at least one input and one output
    metadata.add_input(DocumentTypes.TextDocument)
    metadata.add_output(Uri.NE)

    # (optional) and finally add runtime parameter specifications
    metadata.add_parameter(name='confidence', description='disambiguation confidence score for linking',
                           type='number', default='0.5')
    metadata.add_parameter(name='support', description='resource prominence, i.e. number of in-links in Wikipedia ('
                                                       'lower bound)', type='integer', default=0)
    metadata.add_parameter(name='types', description='limits recognition to certain types of named entities, '
                                                     'e.g. DBpedia:Place', type='string', multivalued=True)
    metadata.add_parameter(name='policy', description='(whitelist) selects all entities of the same type; (blacklist) '
                                                      'selects all entities not of the same type', type='string',
                           choices=['whitelist', 'blacklist'], default='whitelist')

    # CHANGE this line and make sure return the compiled `metadata` instance
    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))