ccp.docs/source/methods_ccp/Gate Cloud Covid19 Vaccine Text Categoriser-1.0.0.json

{
    "title": "Gate Cloud Covid19 Vaccine Text Categoriser",
    "description": "A machine learning classifier trained to categorise text about COVID-19 vaccines into 6 categories - Liberty or Freedom; Development, Provision and Access; Safety, Efficacy and Necessity; Politics and Economics; Conspiracy; Morality, Religiosity and Ethics.  The service returns the top two categories for each input text - for full details see https://cloud.gate.ac.uk/shopfront/displayItem/covid19-vaccine",
    "version": "1.0.0",
    "jobControlOptions": "async-execute",
    "metadata": [
        {
            "title": "Marco Lettere",
            "role": "author",
            "href": "https://accounts.d4science.org/auth/admin/realms/d4science/users/09138708-9a19-4724-93d1-8c721d591da2"
        },
        {
            "role": "category",
            "title": "Text_Classification"
        }
    ],
    "inputs": {
        "ccpimage": {
            "id": "ccpimage",
            "title": "Runtime",
            "description": "The image of the runtime to use for method execution. This depends on the infrastructure specific protocol for interacting with registries.",
            "minOccurs": 1,
            "maxOccurs": 1,
            "schema": {
                "type": "string",
                "format": "url",
                "contentMediaType": "text/plain",
                "default": "hub.dev.d4science.org/ccp-runtimes/gatecloud-base:latest",
                "readOnly": true
            }
        },
        "inputFile": {
            "id": "inputFile",
            "title": "inputFile",
            "description": "Input CSV file()",
            "minOccurs": 1,
            "maxOccurs": 1,
            "schema": {
                "type": "string",
                "format": "remotefile",
                "default": "",
                "contentMediaType": "text/csv"
            }
        },
        "columnSeparator": {
            "id": "columnSeparator",
            "title": "columnSeparator",
            "description": "Separator between columns - comma for a normal CSV file but tab is also supported()",
            "minOccurs": 1,
            "maxOccurs": 1,
            "schema": {
                "type": "string",
                "enum": [
                    "comma",
                    "tab"
                ],
                "default": "comma"
            }
        },
        "hasHeaders": {
            "id": "hasHeaders",
            "title": "hasHeaders",
            "description": "Does the CSV have a header row?()",
            "minOccurs": 1,
            "maxOccurs": 1,
            "schema": {
                "type": "string",
                "format": "boolean",
                "default": "false"
            }
        },
        "textColumn": {
            "id": "textColumn",
            "title": "textColumn",
            "description": "Column name (if hasHeaders) or index (1-based) that contains the text to process()",
            "minOccurs": 1,
            "maxOccurs": 1,
            "schema": {
                "type": "string",
                "format": "none",
                "default": "1"
            }
        },
        "copyColumns": {
            "id": "copyColumns",
            "title": "copyColumns",
            "description": "Comma-separated list of column names (if hasHeaders is true) or indexes (1-based) that should be copied from the input to output, for example a column representing the document identifier. 0 means do not copy any columns to the output.()",
            "minOccurs": 1,
            "maxOccurs": 1,
            "schema": {
                "type": "string",
                "format": "none",
                "default": "0"
            }
        }
    },
    "outputs": {
        "result": {
            "id": "result",
            "title": "result",
            "description": "Result CSV file",
            "minOccurs": 1,
            "maxOccurs": 1,
            "metadata": [
                {
                    "title": "result.csv",
                    "role": "file",
                    "href": "/ccp_data/output/result.csv"
                }
            ],
            "schema": {
                "type": "string",
                "contentEncoding": "binary",
                "contentMediaType": "text/csv"
            }
        }
    },
    "additionalParameters": {
        "parameters": [
            {
                "name": "deploy-script",
                "value": [
                    "./download.sh {{inputFile}}"
                ]
            },
            {
                "name": "execute-script",
                "value": [
                    "python build/covid19-vaccine/standard_service.py /ccp_data/inputFile.csv {{columnSeparator}} {{hasHeaders}} '{{textColumn}}' '{{copyColumns}}'",
                    "cp -f result.csv /ccp_data/"
                ]
            },
            {
                "name": "undeploy-script",
                "value": []
            }
        ]
    },
    "links": [
        {
            "rel": "compatibleWith",
            "title": "D4Science development Infrastructure",
            "href": "infrastructures/d4science-dev-swarm"
        },
        {
            "rel": "compatibleWith",
            "title": "D4Science production Infrastructure",
            "href": "infrastructures/d4science-prod-swarm"
        }
    ],
    "keywords": [
        "gatecloud"
    ],
    "id": "8826b5e6-2151-4b6b-993e-9b88f2a29925"
}