API Reference
Log In

Hardware requirement presets

Overview

Model requirements include the GPU, CPU, and RAM memory needed to run a model. Administrators can create memory and hardware requirement presets for Data Scientists to choose from upon model deployment.

The Model service provides the APIs needed to create and set memory and hardware requirement presets. It provides APIs to list account and model requirement presets, create new presets, and assign and remove presets from accounts and models.

The requirements object

{
  "requirementId": 1,
  "name": "...",
  "description": "...",
  "gpuUnits": 1,
  "cpuAmount": "...",
  "memoryAmount": "...",
  "status": "...",
  "storage": "...",
  "price": "...",
  "instanceType": "..."
}
ParameterTypeDescription
requirementIdstringThe identifier for the memory and hardware requirements preset.
namestringThe requirement preset's name.
descriptionstringThe requirement preset's description.
gpuUnitsnumberAn integer number of GPUs required to run the model container. GPU resources are optional.
cpuAmountstringA number of fractional CPUs required to run the model container. You can limit the percentage of the CPU that the container is allowed to use.
memoryAmountstringThe amount of system memory needed to run the model container (e.g. RAM). Measured in bytes, it can be a plain integer or a fixed-point integer using a suffix. Suffixes may be: G, M, K, or their power-of-two equivalents: Gi, Mi, Ki.Mi".
statusstringThe requirement's status. Values can be ACTIVE and INACTIVE,
storagestringThe hard disk size available for the model instance. It's measured in Gb.
pricestringThe model instance's price per hour.
instanceTypestringThe type of virtual machine needed to run the model.