Microservice
This page has been auto-generated based on an OpenAPI Specification
Most users will prefer this view which may include examples and additional info
| Name | Type | Details |
|---|---|---|
| name | string character varying | description: human readable short, yet descriptive name of the Microservice. |
| version | string character varying | description: version as defined by the user. |
| description | string character varying | description: human readable short description of the Microservice's capabilities. |
| classification_schema | string public.classification_schema | enum: ['Simulation', 'ML', 'others'] description: fine-granular classification of the Microservice |
| type | string ARRAY | description: detailed type of the microservice, list of keywords |
| deployment_format | string public.deployment_format | enum: ['docker-compose', 'kubernetes-manifest'] description: identifier of the deployment environment required to deploy the Microservice's container |
| deployment_data | string json | description: JSON of docker-compose or kubernetes manifest required to run the container |
| configuration_data | string ARRAY | description: List of objects specifying configuration file(s) content required by the service |
| mounted_shared_directories | string character varying | description: A note for developers of co-operating Microservices. Directories that should be shared to the host where this microservice can find required inputs / store outputs |
| recommended_number_of_gpus | integer integer | description: recommended number of GPUs |
| recommended_gpu_ram | integer integer | description: recommended amount of GPU memory in GB |
| gpu_type | string character varying | description: a description of the type of GPUs, and further specifications, to allow the execution of the Microservice |
| hpc_required | boolean boolean | description: whether this Microservice requires an HPC environment to be executed efficiently |
| edge_type | string public.edge_type | enum: ['TPU (Google)', 'NPU (Qualcomm)', 'FPGA', 'NVIDIA Jetson AGX'] description: required type of edge device to allow the execution of the Microservice |
| recommended_ram | integer integer | description: recommended amount of memory in GB |
| recommended_cpus | integer integer | description: recommended number of CPU cores |
| required_disk_space | integer integer | description: required amount of disk space in GB |
| os_arch | string character varying | description: supported os architecture. Defaults to x86 |
| os_type | string character varying | description: supported os type. Defaults to Linux |
| data_resource | string ARRAY | description: list of Data objects for each required data resource, specified using the "DATA" fields in the linked substructure |
| model_types | string ARRAY | description: list of supported Model types |
| model_recommended_auth_tools | string ARRAY | description: list of recommended AuthoringTools used to generate the Model |
| parameters | string ARRAY | description: list of Parameter objects for each possible parameters, to be specified before deployment |
| metrics | string ARRAY | description: list of Metric objects for each metric collected by the Microservice |
| is_gui | boolean boolean | description: (boolean) indicates that this microservice exposes a graphical user interface (web). Defaults to False. |
| workload_type | string public.workload_type | enum: ['service', 'job', 'undefined'] description: (enum["service", "job", "undefined"]) specifies the workload type. service for long running microservices that must be shut-down by the user. job for batch operations that should shut-down after microservice completes succesfully. undefined for other, that must be shut-down by the user. Defaults to undefined. |