¶

ApiKeyExpirationTime¶

ApiKeyExpirationTime()

Fields:

• ONE_MONTH
• THREE_MONTHS
• SIX_MONTHS
• ONE_YEAR
• NEVER

BaseML3Enum¶

BaseML3Enum()

Base class for all enums in the ML3 Platform SDK

ColumnRole¶

ColumnRole()

Column role enum Describe the role of a column

Fields: - INPUT - INPUT_MASK - PREDICTION - TARGET - ERROR - ID - TIME_ID - INPUT_ADDITIONAL_EMBEDDING - TARGET_ADDITIONAL_EMBEDDING - PREDICTION_ADDITIONAL_EMBEDDING - USER_INPUT - RETRIEVED_CONTEXT

ColumnSubRole¶

ColumnSubRole()

Column subrole enum Describe the subrole of a column

Fields: - RAG_USER_INPUT - RAG_RETRIEVED_CONTEXT - MODEL_PROBABILITY - OBJECT_DETECTION_LABEL_TARGET - OBJECT_DETECTION_LABEL_PREDICTION

Currency¶

Currency()

Currency of to use for the Task

Fields: - EURO - DOLLAR

DataStructure¶

DataStructure()

Represents the typology of the data to send

Fields:

• TABULAR
• IMAGE
• TEXT
• EMBEDDING

DataType¶

DataType()

Data type enum Describe data type of input

Fields: - FLOAT - STRING - CATEGORICAL - ARRAY_1 - ARRAY_2 - ARRAY_3

DetectionEventActionType¶

DetectionEventActionType()

Fields:

• DISCORD_NOTIFICATION
• SLACK_NOTIFICATION
• EMAIL_NOTIFICATION
• TEAMS_NOTIFICATION
• MQTT_NOTIFICATION
• RETRAIN

DetectionEventSeverity¶

DetectionEventSeverity()

Fields:

• LOW
• MEDIUM
• HIGH

DetectionEventType¶

DetectionEventType()

Fields:

• WARNING_OFF
• WARNING_ON
• DRIFT_ON
• DRIFT_OFF

ExternalIntegration¶

ExternalIntegration()

An integration with a 3^rd party service provider

Fields: - AWS - GCP - AZURE - AWS_COMPATIBLE

FileType¶

FileType()

Fields:

• CSV
• JSON
• PARQUET
• PNG
• JPG
• NPY

FolderType¶

FolderType()

Type of folder

Fields

• UNCOMPRESSED
• TAR
• ZIP

ImageMode¶

ImageMode()

Image mode enumeration

Fields: - RGB - RGBA - GRAYSCALE

JobStatus¶

JobStatus()

Fields:

• IDLE
• STARTING
• RUNNING
• COMPLETED
• ERROR
• ROLLBACK_COMPLETE

KPIStatus¶

KPIStatus()

Fields:

• NOT_INITIALIZED
• OK
• WARNING
• DRIFT

ModelMetricName¶

ModelMetricName()

Name of the model metrics that is associated with the model

Fields: - RMSE - RSQUARE - ACCURACY - AVERAGE_PRECISION

MonitoringMetric¶

MonitoringMetric()

Fields:

• FEATURE
• TEXT_TOXICITY
• TEXT_EMOTION
• TEXT_SENTIMENT
• MODEL_PERPLEXITY
• IMAGE_BRIGHTNESS
• IMAGE_CONTRAST
• BBOXES_QUANTITY
• BBOXES_AREA

MonitoringStatus¶

MonitoringStatus()

Fields:

• OK
• WARNING
• DRIFT

MonitoringTarget¶

MonitoringTarget()

Fields:

• ERROR
• INPUT
• CONCEPT
• PREDICTION
• INPUT_PREDICTION
• USER_INPUT
• RETRIEVED_CONTEXT
• USER_INPUT_RETRIEVED_CONTEXT
• USER_INPUT_MODEL_OUTPUT
• MODEL_OUTPUT_RETRIEVED_CONTEXT

ProductKeyStatus¶

ProductKeyStatus()

Status of a product key

Fields:: - NEW = generated but not yet used product key - VALIDATING = validation requested from client - IN_USE = validated product key, client activated

RetrainTriggerType¶

RetrainTriggerType()

Enumeration of the possible retrain triggers

Fields:: - AWS_EVENT_BRIDGE - GCP_PUBSUB - AZURE_EVENT_GRID

StoragePolicy¶

StoragePolicy()

Enumeration that specifies the storage policy for the data sent to ML cube Platform

Fields: cloud it needs to read data

StoringDataType¶

StoringDataType()

Fields:

• HISTORICAL
• REFERENCE
• PRODUCTION
• KPI

SubscriptionType¶

SubscriptionType()

Type of subscription plan of a company

Fields:: - CLOUD: subscription plan for web app or sdk access - EDGE: subscription plan for edge deployment

SuggestionType¶

SuggestionType()

Enum to specify the preferred type of suggestion

Fields: - SAMPLE_WEIGHTS - RESAMPLED_DATASET

TaskType¶

TaskType()

Fields:

• REGRESSION
• CLASSIFICATION_BINARY
• CLASSIFICATION_MULTICLASS
• CLASSIFICATION_MULTILABEL
• RAG
• OBJECT_DETECTION

TextLanguage¶

TextLanguage()

Enumeration of text language used in nlp tasks.

Fields: - ITALIAN - ENGLISH - MULTILANGUAGE

UserCompanyRole¶

UserCompanyRole()

Fields:

• COMPANY_OWNER
• COMPANY_ADMIN
• COMPANY_USER
• COMPANY_NONE

UserProjectRole¶

UserProjectRole()

Fields:

• PROJECT_ADMIN
• PROJECT_USER
• PROJECT_VIEW