Risk store objects
Objects and models for drift, explainability, and uncertainty. This data is maintained in the VIANOPS risk store database. See supported Risk store APIs.
vianops_client.models.riskstore.data_profiling
- pydantic model V1DataProfilingJobModel
Bases:
BaseModelShow JSON schema
{ "title": "V1DataProfilingJobModel", "type": "object", "properties": { "inference_mapping": { "title": "Inference Mapping", "description": "Inference mapping object. Inference mapping object is optional if `deployment` , `model_name`, `model_version` and `model_stage` are provided; otherwise, required.", "allOf": [ { "$ref": "#/definitions/V1InferenceMappingModel" } ] }, "deployment": { "title": "Deployment", "description": "Name of the deployment. Deployment is optional if inference_mapping is provided; otherwise, required (along with model_name, 'model_version, and model_stage`).", "type": "string" }, "model_name": { "title": "Model Name", "description": "Name of the model. Model name is optional if inference_mapping is provided; otherwise, required (along with 'deployment`, `model_version`, and `model_stage`).", "type": "string" }, "model_version": { "title": "Model Version", "description": "Version of the model. Model version is optional if inference_mapping is provided; otherwise, required (along with 'deployment`, 'model_name`, and `model_stage`).", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Stage of the model. Model stage is optional if inference_mapping is provided; otherwise, required (along with 'deployment`, 'model_name`, and `model_version`).", "type": "string" }, "policy": { "title": "Policy", "description": "Policy parameters for a data profiling job.", "allOf": [ { "$ref": "#/definitions/V1DataProfilingPolicy" } ] }, "status": { "title": "Status", "description": "Job status.", "type": "string" }, "segments": { "title": "Segments", "description": "List of segments used by the drift policy to be included in the data profiling analysis.", "type": "array", "items": { "$ref": "#/definitions/V1SegmentModel" } } }, "required": [ "policy" ], "example": { "deployment": "Taxi fare model 2 vianai", "model_name": "Taxi fare model 2 vianai", "model_version": "1", "model_stage": "primary", "policy": { "window_parameters": { "target": { "window_type": "day", "process_date": "2023-04-19" }, "baseline": { "window_method": "prior", "window_type": "day", "process_date": "2023-04-19" } } }, "status": "inactive", "segments": [ { "model_uuid": "fe126008-0581-4d10-bc5e-93c0c0cfa157", "name": "Williamsburg-Manhattan segment 1 vianai", "description": "Segment to filter data for particular pickup and dropoff locations in Williamsburg and Manhattan", "filters": [ { "feature_name": "DOLocation", "value": [ "Little Italy/NoLiTa", "Lower East Side" ], "operator": "=", "conjunction": "None", "grouped_filters": "None" } ], "id": 2, "status": "active", "created_ts": "1683132722980.102", "modified_ts": "1683132722980.102", "created_by": "user1", "modified_by": "user2" } ] }, "definitions": { "V1InferenceMappingColumnSchema": { "title": "V1InferenceMappingColumnSchema", "type": "object", "properties": { "feature_id": { "title": "Feature Id", "description": "Id of the feature, generated by the platform for optimization.", "type": "integer" }, "name": { "title": "Name", "description": "Name of column.", "type": "string" }, "dtype": { "title": "Dtype", "description": "Data type of column. For example, `float64`.", "type": "string" }, "sql_type": { "title": "Sql Type", "description": "SQL data type of column. For example, `Float32`.", "type": "string" }, "feature_type": { "title": "Feature Type", "description": "Feature type of column. Acceptable values include `categorical` and `continuous`.", "type": "string" }, "segmentation": { "title": "Segmentation", "description": "If true (the default), the column is enabled for segmentation calculations.", "default": true, "type": "boolean" }, "drift": { "title": "Drift", "description": "If true (the default), the column is enabled for drift calculations.", "default": true, "type": "boolean" }, "hotspot": { "title": "Hotspot", "description": "If true (the default), the column is enabled for hotspot analysis.", "default": false, "type": "boolean" }, "rca": { "title": "Rca", "description": "List of column names included for root cause analysis (rca). Set by the platform based on feature configuration to identify features available for hotspot analysis.", "default": [], "type": "array", "items": { "type": "string" } }, "round": { "title": "Round", "description": "The number of decimals to round to on a continuous float column.", "type": "integer" } }, "required": [ "name", "dtype", "sql_type", "feature_type" ] }, "V1InferenceMappingSchema": { "title": "V1InferenceMappingSchema", "type": "object", "properties": { "target_col": { "title": "Target Col", "description": "Name of target column.", "type": "string" }, "identifier_cols": { "title": "Identifier Cols", "description": "List of identifier columns.", "default": [], "type": "array", "items": { "type": "string" } }, "columns": { "title": "Columns", "description": "List of all columns.", "type": "array", "items": { "$ref": "#/definitions/V1InferenceMappingColumnSchema" } }, "datetime_col": { "title": "Datetime Col", "description": "Name of datetime column", "default": "", "type": "string" }, "predict_proba_col": { "title": "Predict Proba Col", "description": "(Classification models only) Name of column that provides the predict probability.", "type": "string" } }, "required": [ "target_col", "columns" ] }, "V1InferenceMappingModel": { "title": "V1InferenceMappingModel", "type": "object", "properties": { "index": { "title": "Index", "description": "Index identifier.", "type": "integer" }, "deployment": { "title": "Deployment", "description": "Deployment name for the related model.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Model name for the related model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Model version for the related model, e.g., 1.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Model stage for the related model, e.g., primary.", "type": "string" }, "connection": { "title": "Connection", "description": "Database connection for the inference mapping.", "type": "string" }, "df_schema": { "title": "Df Schema", "description": "Dictionary containing dataframe schema for model, i.e., target column, identifier column(s), all columns, datetime column, and predict probability column (classification models only).", "allOf": [ { "$ref": "#/definitions/V1InferenceMappingSchema" } ] }, "identifier_cols_schema": { "title": "Identifier Cols Schema", "description": "List containing identifier columns schema for model." }, "inference_table": { "title": "Inference Table", "description": "Name of inference table for mapping.", "type": "string" }, "ground_truth_table": { "title": "Ground Truth Table", "description": "Name of ground truth table for mapping.", "type": "string" }, "joined_table": { "title": "Joined Table", "description": "Name of joined table for mapping.", "type": "string" }, "key_table": { "title": "Key Table", "description": "Name of key table for mapping.", "type": "string" }, "create_ddl": { "title": "Create Ddl", "description": "The query to create the ddl tables.", "type": "string" }, "postprocessors": { "title": "Postprocessors", "description": "One or more postprocessor (and related params) to include in inference mapping, to transform output data before sending to backend database. The available postprocessors include `PickHighestProbability`, `PickInferenceMapper`, and `PickProbablityThreshold`. For each postprocessor, specify the classname, method, and initparams.", "default": [], "type": "array", "items": { "type": "object" } }, "training_set_id": { "title": "Training Set Id", "description": "Training set id that needs to be specified for training data preprocessing.", "type": "integer" }, "training_table": { "title": "Training Table", "description": "Training table name that needs to be specified for training data preprocessing.", "type": "string" } }, "required": [ "deployment", "model_name", "model_version", "model_stage", "connection", "df_schema" ], "example": { "index": 7, "deployment": "vianai.jt_placeholder_deployment", "model_name": "vianai.jt_placeholder_deployment", "model_version": "1", "model_stage": "primary", "connection": "Internal clickhouse DB", "df_schema": { "target_col": "total_amount", "identifier_cols": [ "pk" ], "columns": [ { "name": "PULocationID", "dtype": "float64", "sql_type": "Float32", "feature_type": "categorical", "feature_id": 1, "drift": true, "segmentation": true }, { "name": "DOLocationID", "dtype": "float64", "sql_type": "Float32", "feature_type": "categorical", "feature_id": 2, "drift": true, "segmentation": true }, { "name": "trip_distance", "dtype": "float64", "sql_type": "Float32", "feature_type": "continuous", "feature_id": 3, "drift": true, "segmentation": true }, { "name": "travel_time", "dtype": "float64", "sql_type": "Float32", "feature_type": "continuous", "feature_id": 4, "drift": true, "segmentation": true }, { "name": "PUdatetime", "dtype": "datetime64[ns]", "sql_type": "", "feature_type": "unknown", "feature_id": 5, "drift": false } ], "datetime_col": "PUdatetime" }, "identifier_cols_schema": null, "inference_table": "16794179557100_dit", "ground_truth_table": "16794179557100_gt", "joined_table": "16794179557100_joined", "key_table": "16794179557100_key", "create_ddl": null, "postprocessors": [ { "classname": "vianai.postprocessing.classification.PickInferenceMapper", "method": "fit_transform", "initparams": { "mapper": "{1:'a',2:'b',3:'c'}" } } ] } }, "V1Target": { "title": "V1Target", "type": "object", "properties": { "window_type": { "title": "Window Type", "description": "The target window type. Accepted values include: `day`, `week`, `month`, `quarter`, and `year`.", "type": "string" }, "process_date": { "title": "Process Date", "description": "The process date.", "type": "string" }, "offset_type": { "title": "Offset Type", "description": "The policy`s offset type. Accepted values include: `week`, `month`, and `quarter`.", "type": "string" }, "offset": { "title": "Offset", "description": "The offset amount.", "type": "integer" }, "start_of_week": { "title": "Start Of Week", "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "type": "string" }, "quarter_start": { "title": "Quarter Start", "description": "The date to start the quarter.", "type": "string" }, "year_start": { "title": "Year Start", "description": "The date to start the year.", "type": "string" } }, "required": [ "window_type" ] }, "V1Baseline": { "title": "V1Baseline", "type": "object", "properties": { "window_method": { "title": "Window Method", "description": "The window method. Supported values: `prior`, `last`, `same_prior_year`, `training` .", "type": "string" }, "window_type": { "title": "Window Type", "description": "The baseline window type. Supported values: `day`, `week`, `month`, `quarter`, `year`, `training`.", "type": "string" }, "last_amount": { "title": "Last Amount", "description": "The last amount of `prior` or `last` for the given window type.", "type": "integer" }, "process_date": { "title": "Process Date", "description": "The process date.", "type": "string" }, "offset_type": { "title": "Offset Type", "description": "The policy`s offset type. Supported values: `week`, `month`, and `quarter`.", "type": "string" }, "offset": { "title": "Offset", "description": "The offset amount.", "type": "integer" }, "start_of_week": { "title": "Start Of Week", "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "type": "string" }, "quarter_start": { "title": "Quarter Start", "description": "The date to start the quarter.", "type": "string" }, "year_start": { "title": "Year Start", "description": "The date to start the year.", "type": "string" } }, "required": [ "window_method", "window_type" ] }, "V1WindowParameters": { "title": "V1WindowParameters", "type": "object", "properties": { "target": { "title": "Target", "description": "The target parameters.", "allOf": [ { "$ref": "#/definitions/V1Target" } ] }, "baseline": { "title": "Baseline", "description": "The baseline parameters.", "allOf": [ { "$ref": "#/definitions/V1Baseline" } ] } }, "required": [ "target", "baseline" ] }, "V1DataProfilingPolicy": { "title": "V1DataProfilingPolicy", "type": "object", "properties": { "window_parameters": { "title": "Window Parameters", "description": "Window parameters for a policy.", "allOf": [ { "$ref": "#/definitions/V1WindowParameters" } ] } }, "required": [ "window_parameters" ] }, "V1BetweenOperatorModel": { "title": "V1BetweenOperatorModel", "type": "object", "properties": { "min": { "title": "Min", "description": "Minimum value of BETWEEN.", "type": "number" }, "max": { "title": "Max", "description": "Maximum value of BETWEEN.", "type": "number" } } }, "V1TopBottomOperatorModel": { "title": "V1TopBottomOperatorModel", "type": "object", "properties": { "direction": { "title": "Direction", "description": "Direction of field values. This field is case-insensitive. Supported directions: `ASC` (ascending), `DESC` (descending). Default is `DESC`.", "default": "DESC", "type": "string" }, "method": { "title": "Method", "description": "Whether it should be the top/bottom percent or flat amount. This field is case-insensitive. Supported methods: `percent`, `flat`. Default is `flat`.", "default": "flat", "type": "string" }, "value": { "title": "Value", "description": "Percent or flat number of rows to take.", "type": "number" } } }, "V1SegmentFilterModel": { "title": "V1SegmentFilterModel", "type": "object", "properties": { "feature_name": { "title": "Feature Name", "description": "Name of feature field to do the operation on.", "type": "string" }, "value": { "title": "Value", "description": "Values of operator doing the filter. Value types supported are based on operator.", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "number" } ] } }, { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "number" }, { "$ref": "#/definitions/V1BetweenOperatorModel" }, { "$ref": "#/definitions/V1TopBottomOperatorModel" } ] }, "operator": { "title": "Operator", "description": "Operation to perform on the feature field. This field is case-insensitive. Supported operators: `=`, `>`, `<`, `<=`, `>=`, `BETWEEN`, `TOP`, `BOTTOM`, `DISTINCT`", "type": "string" }, "conjunction": { "title": "Conjunction", "description": "Relationship to next filter. If there is no next filter, set to null. This field is case-insensitive. Supported values: `AND`, `OR`, `null`. Default value is `null`.", "type": "string" }, "grouped_filters": { "title": "Grouped Filters", "description": "List of grouped filters. Use for creating a nested filter within a filter.", "type": "array", "items": { "type": "object" } } }, "additionalProperties": false, "example": { "feature_name": "FEATURE NAME", "operator": "=", "value": [ "VALUE 1", "VALUE 2" ], "conjunction": "AND", "grouped_filters": [ { "feature_name": "FEATURE NAME", "operator": "=", "value": [ "VALUE 1", "VALUE 2" ], "conjunction": "AND" } ] } }, "V1SegmentModel": { "title": "V1SegmentModel", "type": "object", "properties": { "model_uuid": { "title": "Model Uuid", "description": "Unique identifier for model.", "type": "string" }, "name": { "title": "Name", "description": "Name of the segment.", "type": "string" }, "description": { "title": "Description", "description": "Description of the segment.", "type": "string" }, "filters": { "title": "Filters", "description": "List of segment filters, their conditions, and relationships.", "type": "array", "items": { "$ref": "#/definitions/V1SegmentFilterModel" } }, "id": { "title": "Id", "description": "Unique identifier generated by the platform for the segment.", "type": "integer" }, "status": { "title": "Status", "description": "Current status of the segment. This field is case-insensitive. Possible values: `active`, `inactive` (default), `archived`, `delete`.", "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Timestamp (Unix time in milliseconds) generated when the segment is created. You can specify the timestamp as a float or date time string value.", "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] }, "modified_ts": { "title": "Modified Ts", "description": "Timestamp (Unix time in milliseconds) generated when the segment is modified. You can specify the timestamp as a float or date time string value.", "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] }, "created_by": { "title": "Created By", "description": "User who created the segment.", "type": "string" }, "modified_by": { "title": "Modified By", "description": "User who last modified the segment.", "type": "string" } }, "required": [ "model_uuid", "name", "filters", "id", "status", "created_ts", "modified_ts", "created_by", "modified_by" ], "example": { "id": 1, "model_uuid": "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "name": "NAME", "description": "DESCRIPTION", "filters": [ { "grouped_filters": null, "feature_name": "FEATURE NAME", "operator": "=", "value": [ "VALUE 1", "VALUE 2" ], "conjunction": null } ], "status": "inactive", "created_ts": 1672531200000, "modified_ts": 1672531200000, "created_by": "user1", "modified_by": "user2" } } } }
- Config:
orm_mode: bool = True
schema_extra: dict = {‘example’: {‘deployment’: ‘Taxi fare model 2 vianai’, ‘model_name’: ‘Taxi fare model 2 vianai’, ‘model_version’: ‘1’, ‘model_stage’: ‘primary’, ‘policy’: {‘window_parameters’: {‘target’: {‘window_type’: ‘day’, ‘process_date’: ‘2023-04-19’}, ‘baseline’: {‘window_method’: ‘prior’, ‘window_type’: ‘day’, ‘process_date’: ‘2023-04-19’}}}, ‘status’: ‘inactive’, ‘segments’: [{‘model_uuid’: ‘fe126008-0581-4d10-bc5e-93c0c0cfa157’, ‘name’: ‘Williamsburg-Manhattan segment 1 vianai’, ‘description’: ‘Segment to filter data for particular pickup and dropoff locations in Williamsburg and Manhattan’, ‘filters’: [{‘feature_name’: ‘DOLocation’, ‘value’: [‘Little Italy/NoLiTa’, ‘Lower East Side’], ‘operator’: ‘=’, ‘conjunction’: ‘None’, ‘grouped_filters’: ‘None’}], ‘id’: 2, ‘status’: ‘active’, ‘created_ts’: ‘1683132722980.102’, ‘modified_ts’: ‘1683132722980.102’, ‘created_by’: ‘user1’, ‘modified_by’: ‘user2’}]}}
- Fields:
- field deployment: str | None = None
Name of the deployment. Deployment is optional if inference_mapping is provided; otherwise, required (along with model_name, ‘model_version, and model_stage`).
- field inference_mapping: V1InferenceMappingModel | None = None
Inference mapping object. Inference mapping object is optional if deployment , model_name, model_version and model_stage are provided; otherwise, required.
- field model_name: str | None = None
Name of the model. Model name is optional if inference_mapping is provided; otherwise, required (along with ‘deployment`, model_version, and model_stage).
- field model_stage: str | None = None
Stage of the model. Model stage is optional if inference_mapping is provided; otherwise, required (along with ‘deployment`, ‘model_name`, and model_version).
- field model_version: str | None = None
Version of the model. Model version is optional if inference_mapping is provided; otherwise, required (along with ‘deployment`, ‘model_name`, and model_stage).
- field policy: V1DataProfilingPolicy [Required]
Policy parameters for a data profiling job.
- field segments: List[V1SegmentModel] | None = None
List of segments used by the drift policy to be included in the data profiling analysis.
- field status: str | None = None
Job status.
- pydantic model V1DataProfilingPolicy
Bases:
BaseModelShow JSON schema
{ "title": "V1DataProfilingPolicy", "type": "object", "properties": { "window_parameters": { "title": "Window Parameters", "description": "Window parameters for a policy.", "allOf": [ { "$ref": "#/definitions/V1WindowParameters" } ] } }, "required": [ "window_parameters" ], "definitions": { "V1Target": { "title": "V1Target", "type": "object", "properties": { "window_type": { "title": "Window Type", "description": "The target window type. Accepted values include: `day`, `week`, `month`, `quarter`, and `year`.", "type": "string" }, "process_date": { "title": "Process Date", "description": "The process date.", "type": "string" }, "offset_type": { "title": "Offset Type", "description": "The policy`s offset type. Accepted values include: `week`, `month`, and `quarter`.", "type": "string" }, "offset": { "title": "Offset", "description": "The offset amount.", "type": "integer" }, "start_of_week": { "title": "Start Of Week", "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "type": "string" }, "quarter_start": { "title": "Quarter Start", "description": "The date to start the quarter.", "type": "string" }, "year_start": { "title": "Year Start", "description": "The date to start the year.", "type": "string" } }, "required": [ "window_type" ] }, "V1Baseline": { "title": "V1Baseline", "type": "object", "properties": { "window_method": { "title": "Window Method", "description": "The window method. Supported values: `prior`, `last`, `same_prior_year`, `training` .", "type": "string" }, "window_type": { "title": "Window Type", "description": "The baseline window type. Supported values: `day`, `week`, `month`, `quarter`, `year`, `training`.", "type": "string" }, "last_amount": { "title": "Last Amount", "description": "The last amount of `prior` or `last` for the given window type.", "type": "integer" }, "process_date": { "title": "Process Date", "description": "The process date.", "type": "string" }, "offset_type": { "title": "Offset Type", "description": "The policy`s offset type. Supported values: `week`, `month`, and `quarter`.", "type": "string" }, "offset": { "title": "Offset", "description": "The offset amount.", "type": "integer" }, "start_of_week": { "title": "Start Of Week", "description": "The start day of week. Supported values: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`.", "type": "string" }, "quarter_start": { "title": "Quarter Start", "description": "The date to start the quarter.", "type": "string" }, "year_start": { "title": "Year Start", "description": "The date to start the year.", "type": "string" } }, "required": [ "window_method", "window_type" ] }, "V1WindowParameters": { "title": "V1WindowParameters", "type": "object", "properties": { "target": { "title": "Target", "description": "The target parameters.", "allOf": [ { "$ref": "#/definitions/V1Target" } ] }, "baseline": { "title": "Baseline", "description": "The baseline parameters.", "allOf": [ { "$ref": "#/definitions/V1Baseline" } ] } }, "required": [ "target", "baseline" ] } } }
- field window_parameters: V1WindowParameters [Required]
Window parameters for a policy.
vianops_client.models.riskstore.drift
- pydantic model V1DriftColumnReport
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftColumnReport", "type": "object", "properties": { "column_name": { "title": "Column Name", "type": "string" }, "drift_percentage": { "title": "Drift Percentage", "type": "number" }, "drift_count": { "title": "Drift Count", "type": "integer" } }, "required": [ "column_name", "drift_percentage" ] }
- field column_name: str [Required]
- field drift_count: int | None = None
- field drift_percentage: float [Required]
- pydantic model V1DriftDetectionConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "cron": { "title": "Cron", "type": "string" }, "drift_detections": { "title": "Drift Detections" } }, "required": [ "deployment_name", "model_name", "model_version", "cron" ] }
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field drift_detections: Any = None
- field model_name: str [Required]
- field model_version: str [Required]
- pydantic model V1DriftDetectionModel
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionModel", "type": "object", "properties": { "index": { "title": "Index", "type": "integer" }, "job_id": { "title": "Job Id", "description": "Job ID that ran the drift detection.", "type": "string" }, "deployment": { "title": "Deployment", "description": "Name of the deployment.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Name of the model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Version of the model.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Stage of the model.", "type": "string" }, "hostname": { "title": "Hostname", "description": "Hostname that ran the drift detection.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "Name of the deployment.", "type": "string" }, "featureset_count": { "title": "Featureset Count", "type": "integer" }, "batch_count": { "title": "Batch Count", "type": "integer" }, "runtime": { "title": "Runtime", "type": "number" }, "processed_ts": { "title": "Processed Ts", "type": "number" }, "column_name": { "title": "Column Name", "type": "string" }, "column_type": { "title": "Column Type", "type": "string" }, "drift_array": { "title": "Drift Array", "type": "array", "items": {} }, "drift_count": { "title": "Drift Count", "type": "integer" }, "type": { "title": "Type", "type": "string" }, "training_drift_array": { "title": "Training Drift Array", "type": "array", "items": {} }, "warning_array": { "title": "Warning Array", "type": "array", "items": {} }, "training_warning_array": { "title": "Training Warning Array", "type": "array", "items": {} }, "createddate": { "title": "Createddate", "type": "number" }, "batch_starttime": { "title": "Batch Starttime", "type": "number" }, "key": { "title": "Key", "type": "string" }, "results": { "title": "Results", "type": "object" }, "data_profile": { "title": "Data Profile", "type": "object" }, "status": { "title": "Status", "type": "string" }, "verbose": { "title": "Verbose", "type": "boolean" }, "drift_policy_name": { "title": "Drift Policy Name", "type": "string" }, "limit": { "title": "Limit", "type": "integer" }, "drift_config": { "title": "Drift Config" }, "segment_id": { "title": "Segment Id", "type": "integer" }, "policy_uuid": { "title": "Policy Uuid", "type": "string" } }, "required": [ "deployment" ], "example": { "index": 0, "job_id": "driftdetection-queue-123", "deployment": "vianai.deployment", "model_name": "vianai.model_name", "model_version": "vianai.model_version", "model_stage": "primary", "hostname": "127.0.0.1", "feature_set_name": "vianai.feature_set", "featureset_count": 1000, "batch_count": 100, "runtime": 0.0, "processed_ts": 0.0, "column_name": "feature_a", "column_type": "int", "drift_array": [ { "bin": "value_a", "count": 10 }, { "bin": "value_b", "count": 10 } ], "drift_count": 10, "type": "string", "training_drift_array": [ "string" ], "warning_array": [ "string" ], "training_warning_array": [ "string" ], "createddate": 0, "batch_starttime": 0, "key": "driftdetection-queue-123:vianai.deployment:vianai.model_name", "results": {}, "data_profile": {}, "drift_policy_name": "vianai.policy_a", "limit": 0, "drift_config": "string", "segment_id": 1, "policy_uuid": "abc-123-456" } }
- Config:
orm_mode: bool = True
schema_extra: dict = {‘example’: {‘index’: 0, ‘job_id’: ‘driftdetection-queue-123’, ‘deployment’: ‘vianai.deployment’, ‘model_name’: ‘vianai.model_name’, ‘model_version’: ‘vianai.model_version’, ‘model_stage’: ‘primary’, ‘hostname’: ‘127.0.0.1’, ‘feature_set_name’: ‘vianai.feature_set’, ‘featureset_count’: 1000, ‘batch_count’: 100, ‘runtime’: 0.0, ‘processed_ts’: 0.0, ‘column_name’: ‘feature_a’, ‘column_type’: ‘int’, ‘drift_array’: [{‘bin’: ‘value_a’, ‘count’: 10}, {‘bin’: ‘value_b’, ‘count’: 10}], ‘drift_count’: 10, ‘type’: ‘string’, ‘training_drift_array’: [‘string’], ‘warning_array’: [‘string’], ‘training_warning_array’: [‘string’], ‘createddate’: 0, ‘batch_starttime’: 0, ‘key’: ‘driftdetection-queue-123:vianai.deployment:vianai.model_name’, ‘results’: {}, ‘data_profile’: {}, ‘drift_policy_name’: ‘vianai.policy_a’, ‘limit’: 0, ‘drift_config’: ‘string’, ‘segment_id’: 1, ‘policy_uuid’: ‘abc-123-456’}}
- Fields:
- field batch_count: int | None = None
- field batch_starttime: float | None = None
- field column_name: str | None = None
- field column_type: str | None = None
- field createddate: float | None = None
- field data_profile: dict | None = None
- field deployment: str [Required]
Name of the deployment.
- field drift_array: list | None = None
- field drift_config: Any = None
- field drift_count: int | None = None
- field drift_policy_name: str | None = None
- field feature_set_name: str | None = None
Name of the deployment.
- field featureset_count: int | None = None
- field hostname: str | None = None
Hostname that ran the drift detection.
- field index: int | None = None
- field job_id: str | None = None
Job ID that ran the drift detection.
- field key: str | None = None
- field limit: int | None = None
- field model_name: str | None = None
Name of the model.
- field model_stage: str | None = None
Stage of the model.
- field model_version: str | None = None
Version of the model.
- field policy_uuid: str | None = None
- field processed_ts: float | None = None
- field results: dict | None = None
- field runtime: float | None = None
- field segment_id: int | None = None
- field status: str | None = None
- field training_drift_array: list | None = None
- field training_warning_array: list | None = None
- field type: str | None = None
- field verbose: bool | None = None
- field warning_array: list | None = None
- pydantic model V1DriftDetectionModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionModelList", "type": "array", "items": { "$ref": "#/definitions/V1DriftDetectionModel" }, "definitions": { "V1DriftDetectionModel": { "title": "V1DriftDetectionModel", "type": "object", "properties": { "index": { "title": "Index", "type": "integer" }, "job_id": { "title": "Job Id", "description": "Job ID that ran the drift detection.", "type": "string" }, "deployment": { "title": "Deployment", "description": "Name of the deployment.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Name of the model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Version of the model.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Stage of the model.", "type": "string" }, "hostname": { "title": "Hostname", "description": "Hostname that ran the drift detection.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "Name of the deployment.", "type": "string" }, "featureset_count": { "title": "Featureset Count", "type": "integer" }, "batch_count": { "title": "Batch Count", "type": "integer" }, "runtime": { "title": "Runtime", "type": "number" }, "processed_ts": { "title": "Processed Ts", "type": "number" }, "column_name": { "title": "Column Name", "type": "string" }, "column_type": { "title": "Column Type", "type": "string" }, "drift_array": { "title": "Drift Array", "type": "array", "items": {} }, "drift_count": { "title": "Drift Count", "type": "integer" }, "type": { "title": "Type", "type": "string" }, "training_drift_array": { "title": "Training Drift Array", "type": "array", "items": {} }, "warning_array": { "title": "Warning Array", "type": "array", "items": {} }, "training_warning_array": { "title": "Training Warning Array", "type": "array", "items": {} }, "createddate": { "title": "Createddate", "type": "number" }, "batch_starttime": { "title": "Batch Starttime", "type": "number" }, "key": { "title": "Key", "type": "string" }, "results": { "title": "Results", "type": "object" }, "data_profile": { "title": "Data Profile", "type": "object" }, "status": { "title": "Status", "type": "string" }, "verbose": { "title": "Verbose", "type": "boolean" }, "drift_policy_name": { "title": "Drift Policy Name", "type": "string" }, "limit": { "title": "Limit", "type": "integer" }, "drift_config": { "title": "Drift Config" }, "segment_id": { "title": "Segment Id", "type": "integer" }, "policy_uuid": { "title": "Policy Uuid", "type": "string" } }, "required": [ "deployment" ], "example": { "index": 0, "job_id": "driftdetection-queue-123", "deployment": "vianai.deployment", "model_name": "vianai.model_name", "model_version": "vianai.model_version", "model_stage": "primary", "hostname": "127.0.0.1", "feature_set_name": "vianai.feature_set", "featureset_count": 1000, "batch_count": 100, "runtime": 0.0, "processed_ts": 0.0, "column_name": "feature_a", "column_type": "int", "drift_array": [ { "bin": "value_a", "count": 10 }, { "bin": "value_b", "count": 10 } ], "drift_count": 10, "type": "string", "training_drift_array": [ "string" ], "warning_array": [ "string" ], "training_warning_array": [ "string" ], "createddate": 0, "batch_starttime": 0, "key": "driftdetection-queue-123:vianai.deployment:vianai.model_name", "results": {}, "data_profile": {}, "drift_policy_name": "vianai.policy_a", "limit": 0, "drift_config": "string", "segment_id": 1, "policy_uuid": "abc-123-456" } } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.drift.V1DriftDetectionModel])
- pydantic model V1DriftDetectionReport
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionReport", "type": "object", "properties": { "deployment": { "title": "Deployment", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "model_stage": { "title": "Model Stage", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "num_predicts": { "title": "Num Predicts", "type": "integer" }, "columns": { "title": "Columns", "type": "array", "items": { "$ref": "#/definitions/V1DriftColumnReport" } }, "batch_starttime": { "title": "Batch Starttime", "type": "number" } }, "required": [ "deployment", "runtime", "num_predicts", "columns" ], "definitions": { "V1DriftColumnReport": { "title": "V1DriftColumnReport", "type": "object", "properties": { "column_name": { "title": "Column Name", "type": "string" }, "drift_percentage": { "title": "Drift Percentage", "type": "number" }, "drift_count": { "title": "Drift Count", "type": "integer" } }, "required": [ "column_name", "drift_percentage" ] } } }
- Fields:
- field batch_starttime: float | None = None
- field columns: List[V1DriftColumnReport] [Required]
- field deployment: str [Required]
- field model_name: str | None = None
- field model_stage: str | None = None
- field model_version: str | None = None
- field num_predicts: int [Required]
- field runtime: float [Required]
- pydantic model V1DriftDetectionReportList
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionReportList", "type": "array", "items": { "$ref": "#/definitions/V1DriftDetectionReport" }, "definitions": { "V1DriftColumnReport": { "title": "V1DriftColumnReport", "type": "object", "properties": { "column_name": { "title": "Column Name", "type": "string" }, "drift_percentage": { "title": "Drift Percentage", "type": "number" }, "drift_count": { "title": "Drift Count", "type": "integer" } }, "required": [ "column_name", "drift_percentage" ] }, "V1DriftDetectionReport": { "title": "V1DriftDetectionReport", "type": "object", "properties": { "deployment": { "title": "Deployment", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "model_stage": { "title": "Model Stage", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "num_predicts": { "title": "Num Predicts", "type": "integer" }, "columns": { "title": "Columns", "type": "array", "items": { "$ref": "#/definitions/V1DriftColumnReport" } }, "batch_starttime": { "title": "Batch Starttime", "type": "number" } }, "required": [ "deployment", "runtime", "num_predicts", "columns" ] } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.drift.V1DriftDetectionReport])
- pydantic model V1DriftDetectionSummary
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionSummary", "type": "object", "properties": { "deployment": { "title": "Deployment", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "num_drifts": { "title": "Num Drifts", "type": "integer" }, "num_warns": { "title": "Num Warns", "type": "integer" }, "num_criticals": { "title": "Num Criticals", "type": "integer" }, "warn_level": { "title": "Warn Level", "type": "string" }, "num_input_columns": { "title": "Num Input Columns", "type": "integer" } }, "required": [ "deployment", "runtime", "num_drifts", "num_warns", "num_criticals", "num_input_columns" ] }
- Fields:
- field deployment: str [Required]
- field num_criticals: int [Required]
- field num_drifts: int [Required]
- field num_input_columns: int [Required]
- field num_warns: int [Required]
- field runtime: float [Required]
- field warn_level: str | None = None
- pydantic model V1DriftDetectionSummaryList
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftDetectionSummaryList", "type": "array", "items": { "$ref": "#/definitions/V1DriftDetectionSummary" }, "definitions": { "V1DriftDetectionSummary": { "title": "V1DriftDetectionSummary", "type": "object", "properties": { "deployment": { "title": "Deployment", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "num_drifts": { "title": "Num Drifts", "type": "integer" }, "num_warns": { "title": "Num Warns", "type": "integer" }, "num_criticals": { "title": "Num Criticals", "type": "integer" }, "warn_level": { "title": "Warn Level", "type": "string" }, "num_input_columns": { "title": "Num Input Columns", "type": "integer" } }, "required": [ "deployment", "runtime", "num_drifts", "num_warns", "num_criticals", "num_input_columns" ] } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.drift.V1DriftDetectionSummary])
- pydantic model V1DriftPolicyConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1DriftPolicyConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "model_type": { "title": "Model Type", "type": "string" }, "cron": { "title": "Cron", "type": "string" }, "drift_policies": { "title": "Drift Policies", "type": "array", "items": { "type": "string" } } }, "required": [ "deployment_name", "model_name", "model_version", "cron", "drift_policies" ] }
- Config:
allow_population_by_field_name: bool = True
extra: Extra = allow
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field drift_policies: List[str] [Required]
- field model_name: str [Required]
- field model_type: str | None = None
- field model_version: str [Required]
- pydantic model V1UncertaintyPolicyConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1UncertaintyPolicyConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "cron": { "title": "Cron", "type": "string" }, "uncertainty_policies": { "title": "Uncertainty Policies" } }, "required": [ "deployment_name", "model_name", "model_version", "cron" ] }
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field model_name: str [Required]
- field model_version: str [Required]
- field uncertainty_policies: Any = None
vianops_client.models.riskstore.explainability
- pydantic model V1ExplainabilityModel
Bases:
V1ExplainabilityModelCommonShow JSON schema
{ "title": "V1ExplainabilityModel", "type": "object", "properties": { "job_id": { "title": "Job Id", "description": "Explainability job id.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "Name of featureset.", "type": "string" }, "deployment": { "title": "Deployment", "description": "Deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Model name.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Model stage.", "type": "string" }, "explainability_config": { "title": "Explainability Config", "description": "Explainability configurations.", "type": "object" }, "runtime": { "title": "Runtime", "description": "Name of featureset.", "type": "number" }, "key": { "title": "Key", "description": "A key based on the concatenation of multiple fields.", "type": "string" }, "index": { "title": "Index", "type": "integer" }, "experiment_type": { "title": "Experiment Type", "description": "Experiment type, regression or classification.", "type": "string" }, "experiment_metric": { "title": "Experiment Metric", "description": "Experiment metric.", "type": "string" }, "target_column": { "title": "Target Column", "description": "Name of target column.", "type": "string" }, "categorical_columns": { "title": "Categorical Columns", "description": "List of columns.", "type": "array", "items": { "type": "string" } }, "results": { "title": "Results", "description": "Explainability job results.", "type": "object" } } }
- Config:
orm_mode: bool = True
- Fields:
- field categorical_columns: List[str] | None = None
List of columns.
- field experiment_metric: str | None = None
Experiment metric.
- field experiment_type: str | None = None
Experiment type, regression or classification.
- field index: int | None = None
- field results: dict | None = None
Explainability job results.
- field target_column: str | None = None
Name of target column.
- pydantic model V1ExplainabilityModelCommon
Bases:
BaseModelShow JSON schema
{ "title": "V1ExplainabilityModelCommon", "type": "object", "properties": { "job_id": { "title": "Job Id", "description": "Explainability job id.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "Name of featureset.", "type": "string" }, "deployment": { "title": "Deployment", "description": "Deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Model name.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Model stage.", "type": "string" }, "explainability_config": { "title": "Explainability Config", "description": "Explainability configurations.", "type": "object" }, "runtime": { "title": "Runtime", "description": "Name of featureset.", "type": "number" }, "key": { "title": "Key", "description": "A key based on the concatenation of multiple fields.", "type": "string" } } }
- Config:
orm_mode: bool = True
- Fields:
- field deployment: str | None = None
Deployment name.
- field explainability_config: dict | None = None
Explainability configurations.
- field feature_set_name: str | None = None
Name of featureset.
- field job_id: str | None = None
Explainability job id.
- field key: str | None = None
A key based on the concatenation of multiple fields.
- field model_name: str | None = None
Model name.
- field model_stage: str | None = None
Model stage.
- field model_version: str | None = None
Model version.
- field runtime: float | None = None
Name of featureset.
- pydantic model V1ExplainabilityModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1ExplainabilityModelList", "type": "array", "items": { "$ref": "#/definitions/V1ExplainabilityModel" }, "definitions": { "V1ExplainabilityModel": { "title": "V1ExplainabilityModel", "type": "object", "properties": { "job_id": { "title": "Job Id", "description": "Explainability job id.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "Name of featureset.", "type": "string" }, "deployment": { "title": "Deployment", "description": "Deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Model name.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Model stage.", "type": "string" }, "explainability_config": { "title": "Explainability Config", "description": "Explainability configurations.", "type": "object" }, "runtime": { "title": "Runtime", "description": "Name of featureset.", "type": "number" }, "key": { "title": "Key", "description": "A key based on the concatenation of multiple fields.", "type": "string" }, "index": { "title": "Index", "type": "integer" }, "experiment_type": { "title": "Experiment Type", "description": "Experiment type, regression or classification.", "type": "string" }, "experiment_metric": { "title": "Experiment Metric", "description": "Experiment metric.", "type": "string" }, "target_column": { "title": "Target Column", "description": "Name of target column.", "type": "string" }, "categorical_columns": { "title": "Categorical Columns", "description": "List of columns.", "type": "array", "items": { "type": "string" } }, "results": { "title": "Results", "description": "Explainability job results.", "type": "object" } } } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.explainability.V1ExplainabilityModel])
- pydantic model V1ExplainabilityModelPage
Bases:
PageModelShow JSON schema
{ "title": "V1ExplainabilityModelPage", "type": "object", "properties": { "items": { "title": "Items", "default": [], "type": "array", "items": { "$ref": "#/definitions/V1ExplainabilityModel" } }, "current_page": { "title": "Current Page", "default": 0, "type": "integer" }, "page_size": { "title": "Page Size", "default": 0, "type": "integer" }, "previous_page": { "title": "Previous Page", "type": "integer" }, "next_page": { "title": "Next Page", "type": "integer" }, "has_previous": { "title": "Has Previous", "default": false, "type": "boolean" }, "previous_items": { "title": "Previous Items", "default": 0, "type": "integer" }, "has_next": { "title": "Has Next", "default": false, "type": "boolean" }, "total": { "title": "Total", "default": 0, "type": "integer" }, "pages": { "title": "Pages", "default": 0, "type": "integer" } }, "definitions": { "V1ExplainabilityModel": { "title": "V1ExplainabilityModel", "type": "object", "properties": { "job_id": { "title": "Job Id", "description": "Explainability job id.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "Name of featureset.", "type": "string" }, "deployment": { "title": "Deployment", "description": "Deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Model name.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Model stage.", "type": "string" }, "explainability_config": { "title": "Explainability Config", "description": "Explainability configurations.", "type": "object" }, "runtime": { "title": "Runtime", "description": "Name of featureset.", "type": "number" }, "key": { "title": "Key", "description": "A key based on the concatenation of multiple fields.", "type": "string" }, "index": { "title": "Index", "type": "integer" }, "experiment_type": { "title": "Experiment Type", "description": "Experiment type, regression or classification.", "type": "string" }, "experiment_metric": { "title": "Experiment Metric", "description": "Experiment metric.", "type": "string" }, "target_column": { "title": "Target Column", "description": "Name of target column.", "type": "string" }, "categorical_columns": { "title": "Categorical Columns", "description": "List of columns.", "type": "array", "items": { "type": "string" } }, "results": { "title": "Results", "description": "Explainability job results.", "type": "object" } } } } }
- field items: List[V1ExplainabilityModel] = []
- pydantic model V1ExplainaibilitySearch
Bases:
V1ExplainabilityModelCommonShow JSON schema
{ "title": "V1ExplainaibilitySearch", "type": "object", "properties": { "job_id": { "title": "Job Id", "description": "Explainability job id.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "Name of featureset.", "type": "string" }, "deployment": { "title": "Deployment", "description": "Deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "Model name.", "type": "string" }, "model_version": { "title": "Model Version", "description": "Model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "Model stage.", "type": "string" }, "explainability_config": { "title": "Explainability Config", "description": "Explainability configurations.", "type": "object" }, "runtime": { "title": "Runtime", "description": "Name of featureset.", "type": "number" }, "key": { "title": "Key", "description": "A key based on the concatenation of multiple fields.", "type": "string" }, "hostname": { "title": "Hostname", "description": "The host name.", "type": "string" } } }
- Config:
orm_mode: bool = True
- Fields:
- field hostname: str | None = None
The host name.
vianops_client.models.riskstore.performance
- pydantic model V1ModelMetricsBase
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsBase", "type": "object", "properties": { "model_uuid": { "title": "Model Uuid", "description": "The model unique identifier. Returned from /v1/models as part of V1ModelsModel.", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment unique identifier. Returned from v1/segment as part of V1SegmentModel. To aggregate the data for a specific segment, specify that ID. To aggregate the data for all possible segments for the model, set to 0 or null.", "type": "integer" }, "start_date": { "title": "Start Date", "description": "The start date (Unix timestamp in milliseconds) for the window.", "type": "string", "format": "date" }, "end_date": { "title": "End Date", "description": "The end date (Unix timestamp in milliseconds) for the window.", "type": "string", "format": "date" }, "include_details": { "title": "Include Details", "description": "Optional Flag: Set true to include intermediate dataframe in results.", "default": false, "type": "boolean" } }, "required": [ "model_uuid", "start_date", "end_date" ] }
- Fields:
- field end_date: date [Required]
The end date (Unix timestamp in milliseconds) for the window.
- field model_uuid: str [Required]
The model unique identifier. Returned from /v1/models as part of V1ModelsModel.
- field segment_id: int | None = None
The segment unique identifier. Returned from v1/segment as part of V1SegmentModel. To aggregate the data for a specific segment, specify that ID. To aggregate the data for all possible segments for the model, set to 0 or null.
- field start_date: date [Required]
The start date (Unix timestamp in milliseconds) for the window.
- pydantic model V1ModelMetricsList
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsList", "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricsBase" }, "definitions": { "V1ModelMetricsBase": { "title": "V1ModelMetricsBase", "type": "object", "properties": { "model_uuid": { "title": "Model Uuid", "description": "The model unique identifier. Returned from /v1/models as part of V1ModelsModel.", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment unique identifier. Returned from v1/segment as part of V1SegmentModel. To aggregate the data for a specific segment, specify that ID. To aggregate the data for all possible segments for the model, set to 0 or null.", "type": "integer" }, "start_date": { "title": "Start Date", "description": "The start date (Unix timestamp in milliseconds) for the window.", "type": "string", "format": "date" }, "end_date": { "title": "End Date", "description": "The end date (Unix timestamp in milliseconds) for the window.", "type": "string", "format": "date" }, "include_details": { "title": "Include Details", "description": "Optional Flag: Set true to include intermediate dataframe in results.", "default": false, "type": "boolean" } }, "required": [ "model_uuid", "start_date", "end_date" ] } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.performance.V1ModelMetricsBase])
- pydantic model V1ModelMetricsModel
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsModel", "type": "object", "properties": { "experiment_type": { "title": "Experiment Type", "description": "The experiment type.", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment unique identifier.", "type": "integer" }, "metrics": { "title": "Metrics", "description": "The metrics.", "type": "object" }, "window": { "title": "Window", "description": "The window.", "type": "object" }, "intermediate_details": { "title": "Intermediate Details", "description": "The intermediate details.", "type": "array", "items": { "type": "object" } } }, "required": [ "experiment_type", "metrics", "window" ] }
- Fields:
- field experiment_type: str [Required]
The experiment type.
- field intermediate_details: List[dict] | None = None
The intermediate details.
- field metrics: dict [Required]
The metrics.
- field segment_id: int | None = None
The segment unique identifier.
- field window: dict [Required]
The window.
- dict(*args, **kwargs)
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- pydantic model V1ModelMetricsReturn
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsReturn", "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricsModel" } }, "definitions": { "V1ModelMetricsModel": { "title": "V1ModelMetricsModel", "type": "object", "properties": { "experiment_type": { "title": "Experiment Type", "description": "The experiment type.", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment unique identifier.", "type": "integer" }, "metrics": { "title": "Metrics", "description": "The metrics.", "type": "object" }, "window": { "title": "Window", "description": "The window.", "type": "object" }, "intermediate_details": { "title": "Intermediate Details", "description": "The intermediate details.", "type": "array", "items": { "type": "object" } } }, "required": [ "experiment_type", "metrics", "window" ] } } }
- Fields:
__root__ (Dict[str, List[vianops_client.models.riskstore.performance.V1ModelMetricsModel]])
- pydantic model V1PerformanceBaseModel
Bases:
V1PerformanceModelShow JSON schema
{ "title": "V1PerformanceBaseModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" }, "job_id": { "title": "Job Id", "description": "The performance job id.", "type": "string" }, "deployment": { "title": "Deployment", "description": "The deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "The name of the model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "The model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "The model stage.", "type": "string" }, "hostname": { "title": "Hostname", "description": "The host name.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "The name of the featureset.", "type": "string" }, "experiment_type": { "title": "Experiment Type", "description": "The experiment type, either classification or regression.", "type": "string" }, "policy_name": { "title": "Policy Name", "description": "The name of the performance policy.", "type": "string" }, "policy_uuid": { "title": "Policy Uuid", "description": "The policy's unique identifier", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment's unique identifier.", "type": "integer" }, "model_uuid": { "title": "Model Uuid", "description": "The model's unique identifier.", "type": "string" }, "results": { "title": "Results", "description": "The performance job results." }, "runtime": { "title": "Runtime", "description": "The performance job runtime.", "type": "number" }, "processed_ts": { "title": "Processed Ts", "description": "The processed timestamp.", "type": "number" }, "predict_date": { "title": "Predict Date", "description": "The prediction date.", "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] }, "index": { "title": "Index", "description": "The performance result index.", "type": "integer" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "runtime", "processed_ts", "predict_date" ] }
- Fields:
- field index: int | None = None
The performance result index.
- pydantic model V1PerformanceBaseModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1PerformanceBaseModelList", "type": "array", "items": { "$ref": "#/definitions/V1PerformanceModel" }, "definitions": { "V1PerformanceModel": { "title": "V1PerformanceModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" }, "job_id": { "title": "Job Id", "description": "The performance job id.", "type": "string" }, "deployment": { "title": "Deployment", "description": "The deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "The name of the model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "The model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "The model stage.", "type": "string" }, "hostname": { "title": "Hostname", "description": "The host name.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "The name of the featureset.", "type": "string" }, "experiment_type": { "title": "Experiment Type", "description": "The experiment type, either classification or regression.", "type": "string" }, "policy_name": { "title": "Policy Name", "description": "The name of the performance policy.", "type": "string" }, "policy_uuid": { "title": "Policy Uuid", "description": "The policy's unique identifier", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment's unique identifier.", "type": "integer" }, "model_uuid": { "title": "Model Uuid", "description": "The model's unique identifier.", "type": "string" }, "results": { "title": "Results", "description": "The performance job results." }, "runtime": { "title": "Runtime", "description": "The performance job runtime.", "type": "number" }, "processed_ts": { "title": "Processed Ts", "description": "The processed timestamp.", "type": "number" }, "predict_date": { "title": "Predict Date", "description": "The prediction date.", "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "runtime", "processed_ts", "predict_date" ] } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.performance.V1PerformanceModel])
- pydantic model V1PerformanceModel
Bases:
V1PerformanceUpdatableModelShow JSON schema
{ "title": "V1PerformanceModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" }, "job_id": { "title": "Job Id", "description": "The performance job id.", "type": "string" }, "deployment": { "title": "Deployment", "description": "The deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "The name of the model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "The model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "The model stage.", "type": "string" }, "hostname": { "title": "Hostname", "description": "The host name.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "The name of the featureset.", "type": "string" }, "experiment_type": { "title": "Experiment Type", "description": "The experiment type, either classification or regression.", "type": "string" }, "policy_name": { "title": "Policy Name", "description": "The name of the performance policy.", "type": "string" }, "policy_uuid": { "title": "Policy Uuid", "description": "The policy's unique identifier", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment's unique identifier.", "type": "integer" }, "model_uuid": { "title": "Model Uuid", "description": "The model's unique identifier.", "type": "string" }, "results": { "title": "Results", "description": "The performance job results." }, "runtime": { "title": "Runtime", "description": "The performance job runtime.", "type": "number" }, "processed_ts": { "title": "Processed Ts", "description": "The processed timestamp.", "type": "number" }, "predict_date": { "title": "Predict Date", "description": "The prediction date.", "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "runtime", "processed_ts", "predict_date" ] }
- Fields:
- field deployment: str [Required]
The deployment name.
- field experiment_type: str [Required]
The experiment type, either classification or regression.
- field feature_set_name: str | None = None
The name of the featureset.
- field hostname: str [Required]
The host name.
- field job_id: str [Required]
The performance job id.
- field model_name: str [Required]
The name of the model.
- field model_stage: str [Required]
The model stage.
- field model_uuid: str [Required]
The model’s unique identifier.
- field model_version: str [Required]
The model version.
- field policy_name: str [Required]
The name of the performance policy.
- field policy_uuid: str [Required]
The policy’s unique identifier
- field predict_date: float | datetime [Required]
The prediction date.
- field processed_ts: float [Required]
The processed timestamp.
- field results: Any = None
The performance job results.
- field runtime: float [Required]
The performance job runtime.
- field segment_id: int | None = None
The segment’s unique identifier.
- pydantic model V1PerformanceModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1PerformanceModelList", "type": "array", "items": { "$ref": "#/definitions/V1PerformanceBaseModel" }, "definitions": { "V1PerformanceBaseModel": { "title": "V1PerformanceBaseModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" }, "job_id": { "title": "Job Id", "description": "The performance job id.", "type": "string" }, "deployment": { "title": "Deployment", "description": "The deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "The name of the model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "The model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "The model stage.", "type": "string" }, "hostname": { "title": "Hostname", "description": "The host name.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "The name of the featureset.", "type": "string" }, "experiment_type": { "title": "Experiment Type", "description": "The experiment type, either classification or regression.", "type": "string" }, "policy_name": { "title": "Policy Name", "description": "The name of the performance policy.", "type": "string" }, "policy_uuid": { "title": "Policy Uuid", "description": "The policy's unique identifier", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment's unique identifier.", "type": "integer" }, "model_uuid": { "title": "Model Uuid", "description": "The model's unique identifier.", "type": "string" }, "results": { "title": "Results", "description": "The performance job results." }, "runtime": { "title": "Runtime", "description": "The performance job runtime.", "type": "number" }, "processed_ts": { "title": "Processed Ts", "description": "The processed timestamp.", "type": "number" }, "predict_date": { "title": "Predict Date", "description": "The prediction date.", "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] }, "index": { "title": "Index", "description": "The performance result index.", "type": "integer" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "runtime", "processed_ts", "predict_date" ] } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.performance.V1PerformanceBaseModel])
- pydantic model V1PerformanceModelPage
Bases:
V1PageModelShow JSON schema
{ "title": "V1PerformanceModelPage", "type": "object", "properties": { "items": { "title": "Items", "type": "array", "items": { "$ref": "#/definitions/V1PerformanceBaseModel" } }, "current_page": { "title": "Current Page", "description": "Current page of items.", "default": 0, "type": "integer" }, "page_size": { "title": "Page Size", "description": "Number of items on a page.", "default": 0, "type": "integer" }, "previous_page": { "title": "Previous Page", "description": "Number of the previous page.", "type": "integer" }, "next_page": { "title": "Next Page", "description": "Number of the next page.", "type": "integer" }, "has_previous": { "title": "Has Previous", "description": "Whether or not there is a previous page.", "default": false, "type": "boolean" }, "previous_items": { "title": "Previous Items", "default": 0, "type": "integer" }, "has_next": { "title": "Has Next", "description": "Whether or not there is a next page.", "default": false, "type": "boolean" }, "total": { "title": "Total", "description": "Total number of items returned by search over all pages.", "default": 0, "type": "integer" }, "pages": { "title": "Pages", "description": "Total number of pages returned by search.", "default": 0, "type": "integer" } }, "required": [ "items" ], "definitions": { "V1PerformanceBaseModel": { "title": "V1PerformanceBaseModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" }, "job_id": { "title": "Job Id", "description": "The performance job id.", "type": "string" }, "deployment": { "title": "Deployment", "description": "The deployment name.", "type": "string" }, "model_name": { "title": "Model Name", "description": "The name of the model.", "type": "string" }, "model_version": { "title": "Model Version", "description": "The model version.", "type": "string" }, "model_stage": { "title": "Model Stage", "description": "The model stage.", "type": "string" }, "hostname": { "title": "Hostname", "description": "The host name.", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "description": "The name of the featureset.", "type": "string" }, "experiment_type": { "title": "Experiment Type", "description": "The experiment type, either classification or regression.", "type": "string" }, "policy_name": { "title": "Policy Name", "description": "The name of the performance policy.", "type": "string" }, "policy_uuid": { "title": "Policy Uuid", "description": "The policy's unique identifier", "type": "string" }, "segment_id": { "title": "Segment Id", "description": "The segment's unique identifier.", "type": "integer" }, "model_uuid": { "title": "Model Uuid", "description": "The model's unique identifier.", "type": "string" }, "results": { "title": "Results", "description": "The performance job results." }, "runtime": { "title": "Runtime", "description": "The performance job runtime.", "type": "number" }, "processed_ts": { "title": "Processed Ts", "description": "The processed timestamp.", "type": "number" }, "predict_date": { "title": "Predict Date", "description": "The prediction date.", "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] }, "index": { "title": "Index", "description": "The performance result index.", "type": "integer" } }, "required": [ "job_id", "deployment", "model_name", "model_version", "model_stage", "hostname", "experiment_type", "policy_name", "policy_uuid", "model_uuid", "runtime", "processed_ts", "predict_date" ] } } }
- field items: List[V1PerformanceBaseModel] [Required]
- pydantic model V1PerformancePageSearch
Bases:
V1PageSearch,V1PerformanceSearchShow JSON schema
{ "title": "V1PerformancePageSearch", "type": "object", "properties": { "indices": { "title": "Indices", "description": "List of indices to search for.", "type": "array", "items": { "type": "integer" } }, "job_ids": { "title": "Job Ids", "description": "The list of job_ids to search for.", "type": "array", "items": { "type": "string" } }, "feature_set_names": { "title": "Feature Set Names", "description": "The list of feature set names to search for.", "type": "array", "items": { "type": "string" } }, "deployments": { "title": "Deployments", "description": "The list of deployment names to search for.", "type": "array", "items": { "type": "string" } }, "model_names": { "title": "Model Names", "description": "The list of model names to search for.", "type": "array", "items": { "type": "string" } }, "model_versions": { "title": "Model Versions", "description": "The list of model versions to search for.", "type": "array", "items": { "type": "string" } }, "model_stages": { "title": "Model Stages", "description": "The list of model stages to search for.", "type": "array", "items": { "type": "string" } }, "experiment_types": { "title": "Experiment Types", "description": "The list of experiment types to search for.", "type": "array", "items": { "type": "string" } }, "hostnames": { "title": "Hostnames", "description": "The list of hostnames to search for.", "type": "array", "items": { "type": "string" } }, "statuses": { "title": "Statuses", "description": "The list of statuses to search for.", "type": "array", "items": { "type": "string" } }, "policy_uuids": { "title": "Policy Uuids", "description": "The list of policy unique identifiers to search for.", "type": "array", "items": { "type": "string" } }, "policy_names": { "title": "Policy Names", "description": "The list of policy names to search for.", "type": "array", "items": { "type": "string" } }, "segment_ids": { "title": "Segment Ids", "description": "The list of segment unique identifiers to search for.", "type": "array", "items": { "type": "integer" } }, "model_uuids": { "title": "Model Uuids", "description": "The list of model unique identifiers to search for.", "type": "array", "items": { "type": "string" } }, "runtimes": { "title": "Runtimes", "description": "The list of runtimes to search for.", "type": "array", "items": { "type": "number" } }, "results": { "title": "Results", "description": "The list of results to search for.", "type": "array", "items": {} }, "processed_tss": { "title": "Processed Tss", "description": "The list of processed timestamps to search for.", "type": "array", "items": { "type": "number" } }, "predict_dates": { "title": "Predict Dates", "description": "The list of predict dates to search for.", "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] } }, "keys": { "title": "Keys", "description": "The list of keys to search for.", "type": "array", "items": { "type": "string" } }, "page": { "title": "Page", "description": "Page number to return. Zero-index based. Cannot be less than zero or greater than number of pages. To make sure you don't exceed the number of pages, set `page` to 1 and run this search operation to return the total number items (`total`). Then run it again to return the exact page (`page`) for the specified number of items per page (`page-size`).", "type": "integer" }, "page_size": { "title": "Page Size", "description": "Number of items to return on a page. Default is 25 items per page.", "default": 25, "type": "integer" }, "order": { "title": "Order", "description": "Fields to use for ordering returned pages and the sort direction.", "type": "array", "items": { "$ref": "#/definitions/V1OrderBy" } }, "search": { "title": "Search", "description": "String to search for (case-insensitive) across all fields in previously created items.", "type": "string" } }, "required": [ "page" ], "example": { "page": 1, "page_size": 100, "indices": [ 1, 2 ], "policy_uuids": [ "07f69488-f8a6-4e40-a294-5c2d2bfda64b" ] }, "definitions": { "V1OrderBy": { "title": "V1OrderBy", "type": "object", "properties": { "field": { "title": "Field", "description": "Field to order by.", "type": "string" }, "direction": { "title": "Direction", "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).", "default": "ASC", "type": "string" } }, "required": [ "field" ] } } }
- Config:
schema_extra: dict = {‘example’: {‘page’: 1, ‘page_size’: 100, ‘indices’: [1, 2], ‘policy_uuids’: [‘07f69488-f8a6-4e40-a294-5c2d2bfda64b’]}}
- Fields:
- field order: List[V1OrderBy] | None = None
Fields to use for ordering returned pages and the sort direction.
- field page: int [Required]
Page number to return. Zero-index based. Cannot be less than zero or greater than number of pages. To make sure you don’t exceed the number of pages, set page to 1 and run this search operation to return the total number items (total). Then run it again to return the exact page (page) for the specified number of items per page (page-size).
- field page_size: int = 25
Number of items to return on a page. Default is 25 items per page.
- field search: str | None = None
String to search for (case-insensitive) across all fields in previously created items.
- pydantic model V1PerformanceSearch
Bases:
BaseModelShow JSON schema
{ "title": "V1PerformanceSearch", "type": "object", "properties": { "indices": { "title": "Indices", "description": "List of indices to search for.", "type": "array", "items": { "type": "integer" } }, "job_ids": { "title": "Job Ids", "description": "The list of job_ids to search for.", "type": "array", "items": { "type": "string" } }, "feature_set_names": { "title": "Feature Set Names", "description": "The list of feature set names to search for.", "type": "array", "items": { "type": "string" } }, "deployments": { "title": "Deployments", "description": "The list of deployment names to search for.", "type": "array", "items": { "type": "string" } }, "model_names": { "title": "Model Names", "description": "The list of model names to search for.", "type": "array", "items": { "type": "string" } }, "model_versions": { "title": "Model Versions", "description": "The list of model versions to search for.", "type": "array", "items": { "type": "string" } }, "model_stages": { "title": "Model Stages", "description": "The list of model stages to search for.", "type": "array", "items": { "type": "string" } }, "experiment_types": { "title": "Experiment Types", "description": "The list of experiment types to search for.", "type": "array", "items": { "type": "string" } }, "hostnames": { "title": "Hostnames", "description": "The list of hostnames to search for.", "type": "array", "items": { "type": "string" } }, "statuses": { "title": "Statuses", "description": "The list of statuses to search for.", "type": "array", "items": { "type": "string" } }, "policy_uuids": { "title": "Policy Uuids", "description": "The list of policy unique identifiers to search for.", "type": "array", "items": { "type": "string" } }, "policy_names": { "title": "Policy Names", "description": "The list of policy names to search for.", "type": "array", "items": { "type": "string" } }, "segment_ids": { "title": "Segment Ids", "description": "The list of segment unique identifiers to search for.", "type": "array", "items": { "type": "integer" } }, "model_uuids": { "title": "Model Uuids", "description": "The list of model unique identifiers to search for.", "type": "array", "items": { "type": "string" } }, "runtimes": { "title": "Runtimes", "description": "The list of runtimes to search for.", "type": "array", "items": { "type": "number" } }, "results": { "title": "Results", "description": "The list of results to search for.", "type": "array", "items": {} }, "processed_tss": { "title": "Processed Tss", "description": "The list of processed timestamps to search for.", "type": "array", "items": { "type": "number" } }, "predict_dates": { "title": "Predict Dates", "description": "The list of predict dates to search for.", "type": "array", "items": { "anyOf": [ { "type": "number" }, { "type": "string", "format": "date-time" } ] } }, "keys": { "title": "Keys", "description": "The list of keys to search for.", "type": "array", "items": { "type": "string" } } } }
- Fields:
- field deployments: List[str] | None = None
The list of deployment names to search for.
- field experiment_types: List[str] | None = None
The list of experiment types to search for.
- field feature_set_names: List[str] | None = None
The list of feature set names to search for.
- field hostnames: List[str] | None = None
The list of hostnames to search for.
- field indices: List[int] | None = None
List of indices to search for.
- field job_ids: List[str] | None = None
The list of job_ids to search for.
- field keys: List[str] | None = None
The list of keys to search for.
- field model_names: List[str] | None = None
The list of model names to search for.
- field model_stages: List[str] | None = None
The list of model stages to search for.
- field model_uuids: List[str] | None = None
The list of model unique identifiers to search for.
- field model_versions: List[str] | None = None
The list of model versions to search for.
- field policy_names: List[str] | None = None
The list of policy names to search for.
- field policy_uuids: List[str] | None = None
The list of policy unique identifiers to search for.
- field predict_dates: List[float | datetime] | None = None
The list of predict dates to search for.
- field processed_tss: List[float] | None = None
The list of processed timestamps to search for.
- field results: List[Any] | None = None
The list of results to search for.
- field runtimes: List[float] | None = None
The list of runtimes to search for.
- field segment_ids: List[int] | None = None
The list of segment unique identifiers to search for.
- field statuses: List[str] | None = None
The list of statuses to search for.
- pydantic model V1PerformanceUpdatableModel
Bases:
BaseModelShow JSON schema
{ "title": "V1PerformanceUpdatableModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" } } }
- Fields:
- field key: str | None = None
A concatenation of multiple fields.
- field status: str | None = None
The performance job status.
- pydantic model V1PerformanceUpdateModel
Bases:
V1PerformanceUpdatableModelShow JSON schema
{ "title": "V1PerformanceUpdateModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" }, "index": { "title": "Index", "type": "integer" } }, "required": [ "index" ] }
- Fields:
- field index: int [Required]
- pydantic model V1PerformanceUpdateModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1PerformanceUpdateModelList", "type": "array", "items": { "$ref": "#/definitions/V1PerformanceUpdateModel" }, "definitions": { "V1PerformanceUpdateModel": { "title": "V1PerformanceUpdateModel", "type": "object", "properties": { "status": { "title": "Status", "description": "The performance job status.", "type": "string" }, "key": { "title": "Key", "description": "A concatenation of multiple fields.", "type": "string" }, "index": { "title": "Index", "type": "integer" } }, "required": [ "index" ] } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.performance.V1PerformanceUpdateModel])
vianops_client.models.riskstore.uncertainty
- pydantic model V1UncertaintyModel
Bases:
V1UncertaintyModelSearchShow JSON schema
{ "title": "V1UncertaintyModel", "type": "object", "properties": { "job_id": { "title": "Job Id", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "type": "string" }, "experiment_type": { "title": "Experiment Type", "type": "string" }, "experiment_metric": { "title": "Experiment Metric", "type": "string" }, "target_column": { "title": "Target Column", "type": "string" }, "categorical_columns": { "title": "Categorical Columns", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "key": { "title": "Key", "type": "string" }, "index": { "title": "Index", "type": "integer" }, "results": { "title": "Results", "type": "object" } } }
- Config:
orm_mode: bool = True
- Fields:
- field index: int | None = None
- field results: dict | None = None
- pydantic model V1UncertaintyModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1UncertaintyModelList", "type": "array", "items": { "$ref": "#/definitions/V1UncertaintyModel" }, "definitions": { "V1UncertaintyModel": { "title": "V1UncertaintyModel", "type": "object", "properties": { "job_id": { "title": "Job Id", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "type": "string" }, "experiment_type": { "title": "Experiment Type", "type": "string" }, "experiment_metric": { "title": "Experiment Metric", "type": "string" }, "target_column": { "title": "Target Column", "type": "string" }, "categorical_columns": { "title": "Categorical Columns", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "key": { "title": "Key", "type": "string" }, "index": { "title": "Index", "type": "integer" }, "results": { "title": "Results", "type": "object" } } } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.uncertainty.V1UncertaintyModel])
- pydantic model V1UncertaintyModelPage
Bases:
PageModelShow JSON schema
{ "title": "V1UncertaintyModelPage", "type": "object", "properties": { "items": { "title": "Items", "default": [], "type": "array", "items": { "$ref": "#/definitions/V1UncertaintyModel" } }, "current_page": { "title": "Current Page", "default": 0, "type": "integer" }, "page_size": { "title": "Page Size", "default": 0, "type": "integer" }, "previous_page": { "title": "Previous Page", "type": "integer" }, "next_page": { "title": "Next Page", "type": "integer" }, "has_previous": { "title": "Has Previous", "default": false, "type": "boolean" }, "previous_items": { "title": "Previous Items", "default": 0, "type": "integer" }, "has_next": { "title": "Has Next", "default": false, "type": "boolean" }, "total": { "title": "Total", "default": 0, "type": "integer" }, "pages": { "title": "Pages", "default": 0, "type": "integer" } }, "definitions": { "V1UncertaintyModel": { "title": "V1UncertaintyModel", "type": "object", "properties": { "job_id": { "title": "Job Id", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "type": "string" }, "experiment_type": { "title": "Experiment Type", "type": "string" }, "experiment_metric": { "title": "Experiment Metric", "type": "string" }, "target_column": { "title": "Target Column", "type": "string" }, "categorical_columns": { "title": "Categorical Columns", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "key": { "title": "Key", "type": "string" }, "index": { "title": "Index", "type": "integer" }, "results": { "title": "Results", "type": "object" } } } } }
- field items: List[V1UncertaintyModel] = []
- pydantic model V1UncertaintyModelSearch
Bases:
BaseModelShow JSON schema
{ "title": "V1UncertaintyModelSearch", "type": "object", "properties": { "job_id": { "title": "Job Id", "type": "string" }, "feature_set_name": { "title": "Feature Set Name", "type": "string" }, "experiment_type": { "title": "Experiment Type", "type": "string" }, "experiment_metric": { "title": "Experiment Metric", "type": "string" }, "target_column": { "title": "Target Column", "type": "string" }, "categorical_columns": { "title": "Categorical Columns", "type": "string" }, "runtime": { "title": "Runtime", "type": "number" }, "key": { "title": "Key", "type": "string" } } }
- Fields:
- field categorical_columns: str | None = None
- field experiment_metric: str | None = None
- field experiment_type: str | None = None
- field feature_set_name: str | None = None
- field job_id: str | None = None
- field key: str | None = None
- field runtime: float | None = None
- field target_column: str | None = None
- pydantic model V1UncertaintyPolicyConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1UncertaintyPolicyConfig", "type": "object", "properties": { "deployment_name": { "title": "Deployment Name", "type": "string" }, "model_name": { "title": "Model Name", "type": "string" }, "model_version": { "title": "Model Version", "type": "string" }, "cron": { "title": "Cron", "type": "string" }, "uncertainty_policies": { "title": "Uncertainty Policies" } }, "required": [ "deployment_name", "model_name", "model_version", "cron" ] }
- Fields:
- field cron: str [Required]
- field deployment_name: str [Required]
- field model_name: str [Required]
- field model_version: str [Required]
- field uncertainty_policies: Any = None
vianops_client.api.riskstore.model_metrics
- class V1ModelMetricCategory(value)
Bases:
str,EnumAn enumeration.
- CUSTOM = 'custom'
- LOWER_LEVEL = 'lower_level'
- STANDARD = 'standard'
- class V1ModelMetricLanguage(value)
Bases:
str,EnumAn enumeration.
- PYTHON = 'python'
- PY_STATEMENT = 'py_statement'
- SQL = 'SQL'
- pydantic model V1ModelMetricPythonConfig
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricPythonConfig", "type": "object", "properties": { "classname": { "title": "Classname", "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "type": "string" }, "module": { "title": "Module", "description": "module from class to be imported", "type": "string" }, "method": { "title": "Method", "description": "Method to be executed", "type": "string" }, "init_params": { "title": "Init Params", "description": "params required by method", "type": "object" } }, "required": [ "module", "method" ] }
- field classname: str | None = None
Classname with full package location e.g rootpackage.chhildpackage.ClassName
- field init_params: dict | None = None
params required by method
- field method: str [Required]
Method to be executed
- field module: str [Required]
module from class to be imported
- pydantic model V1ModelMetricSearch
Bases:
V1PageSearchShow JSON schema
{ "title": "V1ModelMetricSearch", "type": "object", "properties": { "page": { "title": "Page", "description": "Page number to return. Zero-index based. Cannot be less than zero or greater than number of pages. To make sure you don't exceed the number of pages, set `page` to 1 and run this search operation to return the total number items (`total`). Then run it again to return the exact page (`page`) for the specified number of items per page (`page-size`).", "type": "integer" }, "page_size": { "title": "Page Size", "description": "Number of items to return on a page. Default is 25 items per page.", "default": 25, "type": "integer" }, "order": { "title": "Order", "description": "Fields to use for ordering returned pages and the sort direction.", "type": "array", "items": { "$ref": "#/definitions/V1OrderBy" } }, "search": { "title": "Search", "description": "String to search for (case-insensitive) across all fields in previously created items.", "type": "string" }, "filters": { "title": "Filters", "description": "Specifies different condition(s) for filtering the results.", "allOf": [ { "$ref": "#/definitions/V1ModelMetricsFilters" } ] } }, "required": [ "page", "filters" ], "example": { "page": 1, "page_size": 100, "order": [ { "field": "metric_name", "direction": "DESC" } ], "search": "vianai", "filters": { "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ], "names": [ "Example model metrics" ] } }, "definitions": { "V1OrderBy": { "title": "V1OrderBy", "type": "object", "properties": { "field": { "title": "Field", "description": "Field to order by.", "type": "string" }, "direction": { "title": "Direction", "description": "Direction to order the field by. Supported values: `ASC` (ascending) and `DESC` (descending) (case-insensitive).", "default": "ASC", "type": "string" } }, "required": [ "field" ] }, "V1ModelMetricTags": { "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "title": "For Display", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_metric_of_interest": { "title": "Is Metric Of Interest", "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "default": false, "type": "boolean" }, "for_custom_definition": { "title": "For Custom Definition", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_percent": { "title": "Is Percent", "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "default": false, "type": "boolean" }, "lower_is_better": { "title": "Lower Is Better", "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "default": false, "type": "boolean" }, "needs_predict_proba": { "title": "Needs Predict Proba", "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "default": false, "type": "boolean" }, "needs_class_of_interest": { "title": "Needs Class Of Interest", "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "default": false, "type": "boolean" } } }, "V1ModelMetricsFilters": { "title": "V1ModelMetricsFilters", "type": "object", "properties": { "created_bys": { "title": "Created Bys", "description": "List of 'created by' users to search for.", "type": "array", "items": { "type": "string" } }, "modified_bys": { "title": "Modified Bys", "description": "List of 'modified by' users to search for.", "type": "array", "items": { "type": "string" } }, "created_ts_start": { "title": "Created Ts Start", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "created_ts_end": { "title": "Created Ts End", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "modified_ts_start": { "title": "Modified Ts Start", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "modified_ts_end": { "title": "Modified Ts End", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "uuids": { "title": "Uuids", "description": "List of metric uuids for this operation.", "type": "array", "items": { "type": "string" } }, "names": { "title": "Names", "description": "List of metric names for this operation.", "type": "array", "items": { "type": "string" } }, "languages": { "title": "Languages", "description": "List of languages for this operation.", "type": "array", "items": { "type": "string" } }, "metric_types": { "title": "Metric Types", "description": "List of metric types for this operation.", "type": "array", "items": { "type": "string" } }, "experiment_types": { "title": "Experiment Types", "description": "List of experiment types for this operation.", "type": "array", "items": { "type": "string" } }, "abbreviations": { "title": "Abbreviations", "description": "List of abbreviations for this operation.", "type": "array", "items": { "type": "string" } }, "alt_names": { "title": "Alt Names", "description": "List of alternative names for this operation.", "type": "array", "items": { "type": "string" } }, "full_names": { "title": "Full Names", "description": "List of full names for this operation.", "type": "array", "items": { "type": "string" } }, "metric_categories": { "title": "Metric Categories", "description": "List of metric categories for this operation.", "type": "array", "items": { "type": "string" } }, "metric_tags": { "title": "Metric Tags", "description": "List of metric tags for this operation.", "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricTags" } }, "statuses": { "title": "Statuses", "description": "List of statuses for this operation.", "type": "array", "items": { "type": "string" } } }, "example": { "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ], "names": [ "Example Metric" ] } } } }
- Config:
schema_extra: dict = {‘example’: {‘page’: 1, ‘page_size’: 100, ‘order’: [{‘field’: ‘metric_name’, ‘direction’: ‘DESC’}], ‘search’: ‘vianai’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example model metrics’]}}}
- Fields:
- field filters: V1ModelMetricsFilters [Required]
Specifies different condition(s) for filtering the results.
- pydantic model V1ModelMetricTags
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "title": "For Display", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_metric_of_interest": { "title": "Is Metric Of Interest", "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "default": false, "type": "boolean" }, "for_custom_definition": { "title": "For Custom Definition", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_percent": { "title": "Is Percent", "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "default": false, "type": "boolean" }, "lower_is_better": { "title": "Lower Is Better", "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "default": false, "type": "boolean" }, "needs_predict_proba": { "title": "Needs Predict Proba", "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "default": false, "type": "boolean" }, "needs_class_of_interest": { "title": "Needs Class Of Interest", "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "default": false, "type": "boolean" } } }
- Fields:
- field for_custom_definition: bool | None = True
for user created custom metric
- field for_display: bool | None = True
for user created custom metric
- field is_metric_of_interest: bool | None = False
If true, this is the metric of interest; otherwise, false (the default, not the metric of interest).
- field is_percent: bool | None = False
If true, this is a percentage value; otherwise, false (the default, this is a numeric value).
- field lower_is_better: bool | None = False
If true, when this metric is evaluated, lower values are better; otherwise, false (the default value, higher values are better).
- field needs_class_of_interest: bool | None = False
If true, the metric needs class of interest; otherwise, false (the default, no need for class of interest).
- field needs_predict_proba: bool | None = False
If true, the metric needs predict probability calculated; otherwise, false (the default, no predict probability needed).
- pydantic model V1ModelMetricsBaseModel
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsBaseModel", "type": "object", "properties": { "description": { "title": "Description", "description": "Description of the metric.", "type": "string" }, "abbreviation": { "title": "Abbreviation", "description": "Abbreviation for the metric name.", "type": "string" }, "alt_names": { "title": "Alt Names", "description": "Alternate names for the metric.", "type": "array", "items": { "type": "string" } }, "full_name": { "title": "Full Name", "description": "Full name of metric", "type": "string" }, "status": { "title": "Status", "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "default": false, "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at last modification time.", "type": "string", "format": "date-time" }, "created_by": { "title": "Created By", "description": "User who created the metric", "type": "string" }, "modified_by": { "title": "Modified By", "description": "User who modified the metric", "type": "string" } }, "example": { "metric_name": "Metric name", "description": "Metric description", "language": "python", "metric_type": "drift-prediction", "experiment_type": "regression", "definition": "Metric definition", "abbreviation": "Abbreviation of metric", "alt_names": [ "Alternative names for metric" ], "full_name": "Metric full name", "status": "active" } }
- Config:
orm_mode: bool = True
schema_extra: dict = {‘example’: {‘metric_name’: ‘Metric name’, ‘description’: ‘Metric description’, ‘language’: ‘python’, ‘metric_type’: ‘drift-prediction’, ‘experiment_type’: ‘regression’, ‘definition’: ‘Metric definition’, ‘abbreviation’: ‘Abbreviation of metric’, ‘alt_names’: [‘Alternative names for metric’], ‘full_name’: ‘Metric full name’, ‘status’: ‘active’}}
- Fields:
- field abbreviation: str | None = None
Abbreviation for the metric name.
- field alt_names: List[str] | None = None
Alternate names for the metric.
- field created_by: str | None = None
User who created the metric
- field created_ts: datetime | None = None
Unix time in milliseconds generated at creation time.
- field description: str | None = None
Description of the metric.
- field full_name: str | None = None
Full name of metric
- field modified_by: str | None = None
User who modified the metric
- field modified_ts: datetime | None = None
Unix time in milliseconds generated at last modification time.
- field status: str | None = False
Current status of the metric. This field is case-insensitive. Possible values: active`(default), `inactive , archived, deleted.
- pydantic model V1ModelMetricsBaseModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsBaseModelList", "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricsBaseModel" }, "definitions": { "V1ModelMetricsBaseModel": { "title": "V1ModelMetricsBaseModel", "type": "object", "properties": { "description": { "title": "Description", "description": "Description of the metric.", "type": "string" }, "abbreviation": { "title": "Abbreviation", "description": "Abbreviation for the metric name.", "type": "string" }, "alt_names": { "title": "Alt Names", "description": "Alternate names for the metric.", "type": "array", "items": { "type": "string" } }, "full_name": { "title": "Full Name", "description": "Full name of metric", "type": "string" }, "status": { "title": "Status", "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "default": false, "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at last modification time.", "type": "string", "format": "date-time" }, "created_by": { "title": "Created By", "description": "User who created the metric", "type": "string" }, "modified_by": { "title": "Modified By", "description": "User who modified the metric", "type": "string" } }, "example": { "metric_name": "Metric name", "description": "Metric description", "language": "python", "metric_type": "drift-prediction", "experiment_type": "regression", "definition": "Metric definition", "abbreviation": "Abbreviation of metric", "alt_names": [ "Alternative names for metric" ], "full_name": "Metric full name", "status": "active" } } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.model_metrics.V1ModelMetricsBaseModel])
- pydantic model V1ModelMetricsFilters
Bases:
V1FiltersCommonShow JSON schema
{ "title": "V1ModelMetricsFilters", "type": "object", "properties": { "created_bys": { "title": "Created Bys", "description": "List of 'created by' users to search for.", "type": "array", "items": { "type": "string" } }, "modified_bys": { "title": "Modified Bys", "description": "List of 'modified by' users to search for.", "type": "array", "items": { "type": "string" } }, "created_ts_start": { "title": "Created Ts Start", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "created_ts_end": { "title": "Created Ts End", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "modified_ts_start": { "title": "Modified Ts Start", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "modified_ts_end": { "title": "Modified Ts End", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "uuids": { "title": "Uuids", "description": "List of metric uuids for this operation.", "type": "array", "items": { "type": "string" } }, "names": { "title": "Names", "description": "List of metric names for this operation.", "type": "array", "items": { "type": "string" } }, "languages": { "title": "Languages", "description": "List of languages for this operation.", "type": "array", "items": { "type": "string" } }, "metric_types": { "title": "Metric Types", "description": "List of metric types for this operation.", "type": "array", "items": { "type": "string" } }, "experiment_types": { "title": "Experiment Types", "description": "List of experiment types for this operation.", "type": "array", "items": { "type": "string" } }, "abbreviations": { "title": "Abbreviations", "description": "List of abbreviations for this operation.", "type": "array", "items": { "type": "string" } }, "alt_names": { "title": "Alt Names", "description": "List of alternative names for this operation.", "type": "array", "items": { "type": "string" } }, "full_names": { "title": "Full Names", "description": "List of full names for this operation.", "type": "array", "items": { "type": "string" } }, "metric_categories": { "title": "Metric Categories", "description": "List of metric categories for this operation.", "type": "array", "items": { "type": "string" } }, "metric_tags": { "title": "Metric Tags", "description": "List of metric tags for this operation.", "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricTags" } }, "statuses": { "title": "Statuses", "description": "List of statuses for this operation.", "type": "array", "items": { "type": "string" } } }, "example": { "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ], "names": [ "Example Metric" ] }, "definitions": { "V1ModelMetricTags": { "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "title": "For Display", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_metric_of_interest": { "title": "Is Metric Of Interest", "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "default": false, "type": "boolean" }, "for_custom_definition": { "title": "For Custom Definition", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_percent": { "title": "Is Percent", "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "default": false, "type": "boolean" }, "lower_is_better": { "title": "Lower Is Better", "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "default": false, "type": "boolean" }, "needs_predict_proba": { "title": "Needs Predict Proba", "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "default": false, "type": "boolean" }, "needs_class_of_interest": { "title": "Needs Class Of Interest", "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "default": false, "type": "boolean" } } } } }
- Config:
fields: dict = {‘uuid’: ‘uuids’, ‘metric_category’: ‘metric_categories’, ‘metric_name’: ‘names’, ‘language’: ‘languages’, ‘metric_type’: ‘metric_types’, ‘experiment_type’: ‘experiment_types’, ‘abbreviation’: ‘abbreviations’, ‘status’: ‘statuses’, ‘full_name’: ‘full_names’, ‘created_by’: ‘created_bys’, ‘modified_by’: ‘modified_bys’}
schema_extra: dict = {‘example’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example Metric’]}}
- Fields:
- field abbreviation: List[str] | None = None (alias 'abbreviations')
List of abbreviations for this operation.
- field alt_names: List[str] | None = None
List of alternative names for this operation.
- field experiment_type: List[str] | None = None (alias 'experiment_types')
List of experiment types for this operation.
- field full_name: List[str] | None = None (alias 'full_names')
List of full names for this operation.
- field language: List[str] | None = None (alias 'languages')
List of languages for this operation.
- field metric_category: List[str] | None = None (alias 'metric_categories')
List of metric categories for this operation.
- field metric_name: List[str] | None = None (alias 'names')
List of metric names for this operation.
- field metric_tags: List[V1ModelMetricTags] | None = None
List of metric tags for this operation.
- field metric_type: List[str] | None = None (alias 'metric_types')
List of metric types for this operation.
- field status: List[str] | None = None (alias 'statuses')
List of statuses for this operation.
- field uuid: List[str] | None = None (alias 'uuids')
List of metric uuids for this operation.
- pydantic model V1ModelMetricsModel
Bases:
V1ModelMetricsBaseModelAdds one or more model metrics.
Show JSON schema
{ "title": "V1ModelMetricsModel", "description": "Adds one or more model metrics.", "type": "object", "properties": { "description": { "title": "Description", "description": "Description of the metric.", "type": "string" }, "abbreviation": { "title": "Abbreviation", "description": "Abbreviation for the metric name.", "type": "string" }, "alt_names": { "title": "Alt Names", "description": "Alternate names for the metric.", "type": "array", "items": { "type": "string" } }, "full_name": { "title": "Full Name", "description": "Full name of metric", "type": "string" }, "status": { "title": "Status", "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "default": false, "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at last modification time.", "type": "string", "format": "date-time" }, "created_by": { "title": "Created By", "description": "User who created the metric", "type": "string" }, "modified_by": { "title": "Modified By", "description": "User who modified the metric", "type": "string" }, "metric_name": { "title": "Metric Name", "description": "Metric name", "type": "string" }, "language": { "description": "Language of metric definition", "allOf": [ { "$ref": "#/definitions/V1ModelMetricLanguage" } ] }, "metric_type": { "description": "Metric type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricType" } ] }, "experiment_type": { "description": "Metric experiment type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricExperimentType" } ] }, "definition": { "title": "Definition", "description": "Metric definition", "anyOf": [ { "$ref": "#/definitions/V1ModelMetricPythonConfig" }, { "type": "string" } ] }, "uuid": { "title": "Uuid", "description": "UUID of the Metric.", "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ] }, "metric_category": { "description": "Metric category", "allOf": [ { "$ref": "#/definitions/V1ModelMetricCategory" } ] }, "metric_tags": { "title": "Metric Tags", "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest", "allOf": [ { "$ref": "#/definitions/V1ModelMetricTags" } ] } }, "required": [ "metric_name", "language", "metric_type", "experiment_type", "definition", "metric_category", "metric_tags" ], "example": { "metric_name": "MAPE", "description": "Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.", "language": "py_statement", "metric_type": "model_performance", "experiment_type": "regression", "definition": "np.mean(np.abs(y_true - y_pred) / y_true) * 100", "abbreviation": "MAPE", "status": "active", "alt_names": [], "metric_category": "custom", "full_name": "Mean Absolute Percentage Error", "metric_tags": { "lower_is_better": true, "needs_predict_proba": false, "is_metric_of_interest": false, "is_percent": false } }, "definitions": { "V1ModelMetricLanguage": { "title": "V1ModelMetricLanguage", "description": "An enumeration.", "enum": [ "python", "SQL", "py_statement" ], "type": "string" }, "V1ModelMetricType": { "title": "V1ModelMetricType", "description": "An enumeration.", "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "type": "string" }, "V1ModelMetricExperimentType": { "title": "V1ModelMetricExperimentType", "description": "An enumeration.", "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering" ], "type": "string" }, "V1ModelMetricPythonConfig": { "title": "V1ModelMetricPythonConfig", "type": "object", "properties": { "classname": { "title": "Classname", "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "type": "string" }, "module": { "title": "Module", "description": "module from class to be imported", "type": "string" }, "method": { "title": "Method", "description": "Method to be executed", "type": "string" }, "init_params": { "title": "Init Params", "description": "params required by method", "type": "object" } }, "required": [ "module", "method" ] }, "V1ModelMetricCategory": { "title": "V1ModelMetricCategory", "description": "An enumeration.", "enum": [ "standard", "custom", "lower_level" ], "type": "string" }, "V1ModelMetricTags": { "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "title": "For Display", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_metric_of_interest": { "title": "Is Metric Of Interest", "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "default": false, "type": "boolean" }, "for_custom_definition": { "title": "For Custom Definition", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_percent": { "title": "Is Percent", "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "default": false, "type": "boolean" }, "lower_is_better": { "title": "Lower Is Better", "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "default": false, "type": "boolean" }, "needs_predict_proba": { "title": "Needs Predict Proba", "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "default": false, "type": "boolean" }, "needs_class_of_interest": { "title": "Needs Class Of Interest", "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "default": false, "type": "boolean" } } } } }
- Config:
orm_mode: bool = True
schema_extra: dict = {‘example’: {‘metric_name’: ‘MAPE’, ‘description’: ‘Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.’, ‘language’: ‘py_statement’, ‘metric_type’: ‘model_performance’, ‘experiment_type’: ‘regression’, ‘definition’: ‘np.mean(np.abs(y_true - y_pred) / y_true) * 100’, ‘abbreviation’: ‘MAPE’, ‘status’: ‘active’, ‘alt_names’: [], ‘metric_category’: ‘custom’, ‘full_name’: ‘Mean Absolute Percentage Error’, ‘metric_tags’: {‘lower_is_better’: True, ‘needs_predict_proba’: False, ‘is_metric_of_interest’: False, ‘is_percent’: False}}}
- Fields:
definition (vianops_client.models.riskstore.model_metrics.V1ModelMetricPythonConfig | str)experiment_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricExperimentType)language (vianops_client.models.riskstore.model_metrics.V1ModelMetricLanguage)metric_category (vianops_client.models.riskstore.model_metrics.V1ModelMetricCategory)metric_tags (vianops_client.models.riskstore.model_metrics.V1ModelMetricTags)metric_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricType)
- field definition: V1ModelMetricPythonConfig | str [Required]
Metric definition
- field experiment_type: V1ModelMetricExperimentType [Required]
Metric experiment type
- field language: V1ModelMetricLanguage [Required]
Language of metric definition
- field metric_category: V1ModelMetricCategory [Required]
Metric category
- field metric_name: str [Required]
Metric name
- field metric_tags: V1ModelMetricTags [Required]
Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest
- field metric_type: V1ModelMetricType [Required]
Metric type
- field uuid: str | UUID | None = None
UUID of the Metric.
- pydantic model V1ModelMetricsModelList
Bases:
BaseModelShow JSON schema
{ "title": "V1ModelMetricsModelList", "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricsModel" }, "definitions": { "V1ModelMetricLanguage": { "title": "V1ModelMetricLanguage", "description": "An enumeration.", "enum": [ "python", "SQL", "py_statement" ], "type": "string" }, "V1ModelMetricType": { "title": "V1ModelMetricType", "description": "An enumeration.", "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "type": "string" }, "V1ModelMetricExperimentType": { "title": "V1ModelMetricExperimentType", "description": "An enumeration.", "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering" ], "type": "string" }, "V1ModelMetricPythonConfig": { "title": "V1ModelMetricPythonConfig", "type": "object", "properties": { "classname": { "title": "Classname", "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "type": "string" }, "module": { "title": "Module", "description": "module from class to be imported", "type": "string" }, "method": { "title": "Method", "description": "Method to be executed", "type": "string" }, "init_params": { "title": "Init Params", "description": "params required by method", "type": "object" } }, "required": [ "module", "method" ] }, "V1ModelMetricCategory": { "title": "V1ModelMetricCategory", "description": "An enumeration.", "enum": [ "standard", "custom", "lower_level" ], "type": "string" }, "V1ModelMetricTags": { "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "title": "For Display", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_metric_of_interest": { "title": "Is Metric Of Interest", "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "default": false, "type": "boolean" }, "for_custom_definition": { "title": "For Custom Definition", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_percent": { "title": "Is Percent", "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "default": false, "type": "boolean" }, "lower_is_better": { "title": "Lower Is Better", "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "default": false, "type": "boolean" }, "needs_predict_proba": { "title": "Needs Predict Proba", "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "default": false, "type": "boolean" }, "needs_class_of_interest": { "title": "Needs Class Of Interest", "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "default": false, "type": "boolean" } } }, "V1ModelMetricsModel": { "title": "V1ModelMetricsModel", "description": "Adds one or more model metrics.", "type": "object", "properties": { "description": { "title": "Description", "description": "Description of the metric.", "type": "string" }, "abbreviation": { "title": "Abbreviation", "description": "Abbreviation for the metric name.", "type": "string" }, "alt_names": { "title": "Alt Names", "description": "Alternate names for the metric.", "type": "array", "items": { "type": "string" } }, "full_name": { "title": "Full Name", "description": "Full name of metric", "type": "string" }, "status": { "title": "Status", "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "default": false, "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at last modification time.", "type": "string", "format": "date-time" }, "created_by": { "title": "Created By", "description": "User who created the metric", "type": "string" }, "modified_by": { "title": "Modified By", "description": "User who modified the metric", "type": "string" }, "metric_name": { "title": "Metric Name", "description": "Metric name", "type": "string" }, "language": { "description": "Language of metric definition", "allOf": [ { "$ref": "#/definitions/V1ModelMetricLanguage" } ] }, "metric_type": { "description": "Metric type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricType" } ] }, "experiment_type": { "description": "Metric experiment type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricExperimentType" } ] }, "definition": { "title": "Definition", "description": "Metric definition", "anyOf": [ { "$ref": "#/definitions/V1ModelMetricPythonConfig" }, { "type": "string" } ] }, "uuid": { "title": "Uuid", "description": "UUID of the Metric.", "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ] }, "metric_category": { "description": "Metric category", "allOf": [ { "$ref": "#/definitions/V1ModelMetricCategory" } ] }, "metric_tags": { "title": "Metric Tags", "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest", "allOf": [ { "$ref": "#/definitions/V1ModelMetricTags" } ] } }, "required": [ "metric_name", "language", "metric_type", "experiment_type", "definition", "metric_category", "metric_tags" ], "example": { "metric_name": "MAPE", "description": "Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.", "language": "py_statement", "metric_type": "model_performance", "experiment_type": "regression", "definition": "np.mean(np.abs(y_true - y_pred) / y_true) * 100", "abbreviation": "MAPE", "status": "active", "alt_names": [], "metric_category": "custom", "full_name": "Mean Absolute Percentage Error", "metric_tags": { "lower_is_better": true, "needs_predict_proba": false, "is_metric_of_interest": false, "is_percent": false } } } } }
- Fields:
__root__ (List[vianops_client.models.riskstore.model_metrics.V1ModelMetricsModel])
- pydantic model V1ModelMetricsModelPage
Bases:
V1PageModelShow JSON schema
{ "title": "V1ModelMetricsModelPage", "type": "object", "properties": { "items": { "title": "Items", "description": "Model metrics returned by search in page.", "default": [], "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricsModel" } }, "current_page": { "title": "Current Page", "description": "Current page of items.", "default": 0, "type": "integer" }, "page_size": { "title": "Page Size", "description": "Number of items on a page.", "default": 0, "type": "integer" }, "previous_page": { "title": "Previous Page", "description": "Number of the previous page.", "type": "integer" }, "next_page": { "title": "Next Page", "description": "Number of the next page.", "type": "integer" }, "has_previous": { "title": "Has Previous", "description": "Whether or not there is a previous page.", "default": false, "type": "boolean" }, "previous_items": { "title": "Previous Items", "default": 0, "type": "integer" }, "has_next": { "title": "Has Next", "description": "Whether or not there is a next page.", "default": false, "type": "boolean" }, "total": { "title": "Total", "description": "Total number of items returned by search over all pages.", "default": 0, "type": "integer" }, "pages": { "title": "Pages", "description": "Total number of pages returned by search.", "default": 0, "type": "integer" } }, "example": { "items": [ { "metric_name": "Metric name 2", "description": "Metric description", "language": "Python", "metric_type": "drift-feature", "experiment_type": "regression", "definition": "Metric definition", "abbreviation": "Abbreviation of metric", "alt_names": [ "Alternative names for metric" ], "full_name": "Metric name", "metric_tags": { "needs_predict_proba": false, "is_standard": false, "is_metric_of_interest": false, "is_percent": false }, "status": "active", "created_ts": 1675292368, "modified_ts": 1675292368, "created_by": "user1", "modified_by": "user1", "uuid": "a09fad35-a841-4869-b812-8acac735c668" } ], "current_page": 1, "page_size": 100, "previous_page": null, "next_page": null, "has_previous": false, "previous_items": 0, "has_next": false, "total": 1, "pages": 1 }, "definitions": { "V1ModelMetricLanguage": { "title": "V1ModelMetricLanguage", "description": "An enumeration.", "enum": [ "python", "SQL", "py_statement" ], "type": "string" }, "V1ModelMetricType": { "title": "V1ModelMetricType", "description": "An enumeration.", "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "type": "string" }, "V1ModelMetricExperimentType": { "title": "V1ModelMetricExperimentType", "description": "An enumeration.", "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering" ], "type": "string" }, "V1ModelMetricPythonConfig": { "title": "V1ModelMetricPythonConfig", "type": "object", "properties": { "classname": { "title": "Classname", "description": "Classname with full package location e.g rootpackage.chhildpackage.ClassName", "type": "string" }, "module": { "title": "Module", "description": "module from class to be imported", "type": "string" }, "method": { "title": "Method", "description": "Method to be executed", "type": "string" }, "init_params": { "title": "Init Params", "description": "params required by method", "type": "object" } }, "required": [ "module", "method" ] }, "V1ModelMetricCategory": { "title": "V1ModelMetricCategory", "description": "An enumeration.", "enum": [ "standard", "custom", "lower_level" ], "type": "string" }, "V1ModelMetricTags": { "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "title": "For Display", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_metric_of_interest": { "title": "Is Metric Of Interest", "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "default": false, "type": "boolean" }, "for_custom_definition": { "title": "For Custom Definition", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_percent": { "title": "Is Percent", "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "default": false, "type": "boolean" }, "lower_is_better": { "title": "Lower Is Better", "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "default": false, "type": "boolean" }, "needs_predict_proba": { "title": "Needs Predict Proba", "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "default": false, "type": "boolean" }, "needs_class_of_interest": { "title": "Needs Class Of Interest", "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "default": false, "type": "boolean" } } }, "V1ModelMetricsModel": { "title": "V1ModelMetricsModel", "description": "Adds one or more model metrics.", "type": "object", "properties": { "description": { "title": "Description", "description": "Description of the metric.", "type": "string" }, "abbreviation": { "title": "Abbreviation", "description": "Abbreviation for the metric name.", "type": "string" }, "alt_names": { "title": "Alt Names", "description": "Alternate names for the metric.", "type": "array", "items": { "type": "string" } }, "full_name": { "title": "Full Name", "description": "Full name of metric", "type": "string" }, "status": { "title": "Status", "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "default": false, "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at last modification time.", "type": "string", "format": "date-time" }, "created_by": { "title": "Created By", "description": "User who created the metric", "type": "string" }, "modified_by": { "title": "Modified By", "description": "User who modified the metric", "type": "string" }, "metric_name": { "title": "Metric Name", "description": "Metric name", "type": "string" }, "language": { "description": "Language of metric definition", "allOf": [ { "$ref": "#/definitions/V1ModelMetricLanguage" } ] }, "metric_type": { "description": "Metric type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricType" } ] }, "experiment_type": { "description": "Metric experiment type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricExperimentType" } ] }, "definition": { "title": "Definition", "description": "Metric definition", "anyOf": [ { "$ref": "#/definitions/V1ModelMetricPythonConfig" }, { "type": "string" } ] }, "uuid": { "title": "Uuid", "description": "UUID of the Metric.", "anyOf": [ { "type": "string" }, { "type": "string", "format": "uuid" } ] }, "metric_category": { "description": "Metric category", "allOf": [ { "$ref": "#/definitions/V1ModelMetricCategory" } ] }, "metric_tags": { "title": "Metric Tags", "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest", "allOf": [ { "$ref": "#/definitions/V1ModelMetricTags" } ] } }, "required": [ "metric_name", "language", "metric_type", "experiment_type", "definition", "metric_category", "metric_tags" ], "example": { "metric_name": "MAPE", "description": "Calculates the Mean Absolute Percentage Error (MAPE) between the true and predicted values.", "language": "py_statement", "metric_type": "model_performance", "experiment_type": "regression", "definition": "np.mean(np.abs(y_true - y_pred) / y_true) * 100", "abbreviation": "MAPE", "status": "active", "alt_names": [], "metric_category": "custom", "full_name": "Mean Absolute Percentage Error", "metric_tags": { "lower_is_better": true, "needs_predict_proba": false, "is_metric_of_interest": false, "is_percent": false } } } } }
- Config:
schema_extra: dict = {‘example’: {‘items’: [{‘metric_name’: ‘Metric name 2’, ‘description’: ‘Metric description’, ‘language’: ‘Python’, ‘metric_type’: ‘drift-feature’, ‘experiment_type’: ‘regression’, ‘definition’: ‘Metric definition’, ‘abbreviation’: ‘Abbreviation of metric’, ‘alt_names’: [‘Alternative names for metric’], ‘full_name’: ‘Metric name’, ‘metric_tags’: {‘needs_predict_proba’: False, ‘is_standard’: False, ‘is_metric_of_interest’: False, ‘is_percent’: False}, ‘status’: ‘active’, ‘created_ts’: 1675292368, ‘modified_ts’: 1675292368, ‘created_by’: ‘user1’, ‘modified_by’: ‘user1’, ‘uuid’: ‘a09fad35-a841-4869-b812-8acac735c668’}], ‘current_page’: 1, ‘page_size’: 100, ‘previous_page’: None, ‘next_page’: None, ‘has_previous’: False, ‘previous_items’: 0, ‘has_next’: False, ‘total’: 1, ‘pages’: 1}}
- Fields:
- field items: List[V1ModelMetricsModel] = []
Model metrics returned by search in page.
- pydantic model V1ModelMetricsUpdates
Bases:
V1ModelMetricsBaseModelShow JSON schema
{ "title": "V1ModelMetricsUpdates", "type": "object", "properties": { "description": { "title": "Description", "description": "Metric description", "type": "string" }, "abbreviation": { "title": "Abbreviation", "description": "Abbreviation for the metric name.", "type": "string" }, "alt_names": { "title": "Alt Names", "description": "Alternate names for the metric.", "type": "array", "items": { "type": "string" } }, "full_name": { "title": "Full Name", "description": "Full name of metric", "type": "string" }, "status": { "title": "Status", "description": "Current status of the metric. This field is case-insensitive. Possible values: `active`(default), `inactive` , `archived`, `deleted`.", "default": false, "type": "string" }, "created_ts": { "title": "Created Ts", "description": "Unix time in milliseconds generated at creation time.", "type": "string", "format": "date-time" }, "modified_ts": { "title": "Modified Ts", "description": "Unix time in milliseconds generated at last modification time.", "type": "string", "format": "date-time" }, "created_by": { "title": "Created By", "description": "User who created the metric", "type": "string" }, "modified_by": { "title": "Modified By", "description": "User who modified the metric", "type": "string" }, "metric_name": { "title": "Metric Name", "description": "Metric name", "type": "string" }, "language": { "description": "Language of metric definition", "allOf": [ { "$ref": "#/definitions/V1ModelMetricLanguage" } ] }, "metric_type": { "description": "Metric type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricType" } ] }, "experiment_type": { "description": "Metric experiment type", "allOf": [ { "$ref": "#/definitions/V1ModelMetricExperimentType" } ] }, "metric_category": { "description": "Metric category", "allOf": [ { "$ref": "#/definitions/V1ModelMetricCategory" } ] }, "metric_tags": { "title": "Metric Tags", "description": "Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest", "allOf": [ { "$ref": "#/definitions/V1ModelMetricTags" } ] }, "definition": { "title": "Definition", "description": "Metric definition", "type": "string" }, "filters": { "title": "Filters", "description": "Specifies different condition(s) for filtering the results.", "allOf": [ { "$ref": "#/definitions/V1ModelMetricsFilters" } ] } }, "required": [ "filters" ], "example": { "metric_name": "Updated metric name", "description": "Updated metric description", "filters": { "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ], "names": [ "Example Metric" ] } }, "definitions": { "V1ModelMetricLanguage": { "title": "V1ModelMetricLanguage", "description": "An enumeration.", "enum": [ "python", "SQL", "py_statement" ], "type": "string" }, "V1ModelMetricType": { "title": "V1ModelMetricType", "description": "An enumeration.", "enum": [ "model_performance", "drift-feature", "drift-prediction", "data-profiling", "fairness-bias", "explainability", "outliers", "uncertainty" ], "type": "string" }, "V1ModelMetricExperimentType": { "title": "V1ModelMetricExperimentType", "description": "An enumeration.", "enum": [ "regression", "binary_classification", "multiclass_classification", "multilabel_classification", "ranking", "clustering" ], "type": "string" }, "V1ModelMetricCategory": { "title": "V1ModelMetricCategory", "description": "An enumeration.", "enum": [ "standard", "custom", "lower_level" ], "type": "string" }, "V1ModelMetricTags": { "title": "V1ModelMetricTags", "type": "object", "properties": { "for_display": { "title": "For Display", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_metric_of_interest": { "title": "Is Metric Of Interest", "description": "If `true`, this is the metric of interest; otherwise, `false` (the default, not the metric of interest).", "default": false, "type": "boolean" }, "for_custom_definition": { "title": "For Custom Definition", "description": "for user created custom metric", "default": true, "type": "boolean" }, "is_percent": { "title": "Is Percent", "description": "If `true`, this is a percentage value; otherwise, `false` (the default, this is a numeric value).", "default": false, "type": "boolean" }, "lower_is_better": { "title": "Lower Is Better", "description": "If `true`, when this metric is evaluated, lower values are better; otherwise, `false` (the default value, higher values are better).", "default": false, "type": "boolean" }, "needs_predict_proba": { "title": "Needs Predict Proba", "description": "If `true`, the metric needs predict probability calculated; otherwise, `false` (the default, no predict probability needed).", "default": false, "type": "boolean" }, "needs_class_of_interest": { "title": "Needs Class Of Interest", "description": "If `true`, the metric needs class of interest; otherwise, `false` (the default, no need for class of interest).", "default": false, "type": "boolean" } } }, "V1ModelMetricsFilters": { "title": "V1ModelMetricsFilters", "type": "object", "properties": { "created_bys": { "title": "Created Bys", "description": "List of 'created by' users to search for.", "type": "array", "items": { "type": "string" } }, "modified_bys": { "title": "Modified Bys", "description": "List of 'modified by' users to search for.", "type": "array", "items": { "type": "string" } }, "created_ts_start": { "title": "Created Ts Start", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "created_ts_end": { "title": "Created Ts End", "description": "Unix time in milliseconds for searching for all objects created during a specified time period.", "type": "number" }, "modified_ts_start": { "title": "Modified Ts Start", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "modified_ts_end": { "title": "Modified Ts End", "description": "Unix time in milliseconds for searching for all objects modified during a specified time period.", "type": "number" }, "uuids": { "title": "Uuids", "description": "List of metric uuids for this operation.", "type": "array", "items": { "type": "string" } }, "names": { "title": "Names", "description": "List of metric names for this operation.", "type": "array", "items": { "type": "string" } }, "languages": { "title": "Languages", "description": "List of languages for this operation.", "type": "array", "items": { "type": "string" } }, "metric_types": { "title": "Metric Types", "description": "List of metric types for this operation.", "type": "array", "items": { "type": "string" } }, "experiment_types": { "title": "Experiment Types", "description": "List of experiment types for this operation.", "type": "array", "items": { "type": "string" } }, "abbreviations": { "title": "Abbreviations", "description": "List of abbreviations for this operation.", "type": "array", "items": { "type": "string" } }, "alt_names": { "title": "Alt Names", "description": "List of alternative names for this operation.", "type": "array", "items": { "type": "string" } }, "full_names": { "title": "Full Names", "description": "List of full names for this operation.", "type": "array", "items": { "type": "string" } }, "metric_categories": { "title": "Metric Categories", "description": "List of metric categories for this operation.", "type": "array", "items": { "type": "string" } }, "metric_tags": { "title": "Metric Tags", "description": "List of metric tags for this operation.", "type": "array", "items": { "$ref": "#/definitions/V1ModelMetricTags" } }, "statuses": { "title": "Statuses", "description": "List of statuses for this operation.", "type": "array", "items": { "type": "string" } } }, "example": { "uuids": [ "5efc9544-e84a-4a94-9e6d-5774e1c609ab", "9140dd05-3f7a-49a4-b625-379880bd9606" ], "names": [ "Example Metric" ] } } } }
- Config:
schema_extra: dict = {‘example’: {‘metric_name’: ‘Updated metric name’, ‘description’: ‘Updated metric description’, ‘filters’: {‘uuids’: [‘5efc9544-e84a-4a94-9e6d-5774e1c609ab’, ‘9140dd05-3f7a-49a4-b625-379880bd9606’], ‘names’: [‘Example Metric’]}}}
- Fields:
experiment_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricExperimentType | None)filters (vianops_client.models.riskstore.model_metrics.V1ModelMetricsFilters)language (vianops_client.models.riskstore.model_metrics.V1ModelMetricLanguage | None)metric_category (vianops_client.models.riskstore.model_metrics.V1ModelMetricCategory | None)metric_tags (vianops_client.models.riskstore.model_metrics.V1ModelMetricTags | None)metric_type (vianops_client.models.riskstore.model_metrics.V1ModelMetricType | None)
- field definition: str | None = None
Metric definition
- field description: str | None = None
Metric description
- field experiment_type: V1ModelMetricExperimentType | None = None
Metric experiment type
- field filters: V1ModelMetricsFilters [Required]
Specifies different condition(s) for filtering the results.
- field language: V1ModelMetricLanguage | None = None
Language of metric definition
- field metric_category: V1ModelMetricCategory | None = None
Metric category
- field metric_name: str | None = None
Metric name
- field metric_tags: V1ModelMetricTags | None = None
Metric tags, includes for_display, is_metric_of_interest, for_custom_definition, is_percent, lower_is_better, needs_predict_proba, needs_class_of_interest
- field metric_type: V1ModelMetricType | None = None
Metric type