Model Risk Result¶

pydantic model ibm_watsonx_gov.entities.model_risk_result.Benchmark¶

Bases: BaseModel

Show JSON schema

{
   "title": "Benchmark",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "metrics": {
         "items": {
            "$ref": "#/$defs/RiskMetric"
         },
         "title": "Metrics",
         "type": "array"
      }
   },
   "$defs": {
      "RiskMetric": {
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "number"
                     },
                     "type": "array"
                  }
               ],
               "title": "Value"
            }
         },
         "required": [
            "name",
            "value"
         ],
         "title": "RiskMetric",
         "type": "object"
      }
   },
   "required": [
      "name",
      "metrics"
   ]
}

Fields:

metrics (list[ibm_watsonx_gov.entities.model_risk_result.RiskMetric])
name (str)

field metrics: list[RiskMetric] [Required]¶

field name: str [Required]¶

get_metric_df() → DataFrame¶

pydantic model ibm_watsonx_gov.entities.model_risk_result.ModelRiskResult¶

Bases: BaseModel

Show JSON schema

{
   "title": "ModelRiskResult",
   "type": "object",
   "properties": {
      "risks": {
         "items": {
            "$ref": "#/$defs/Risk"
         },
         "title": "Risks",
         "type": "array"
      },
      "output_file_path": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Output File Path"
      }
   },
   "$defs": {
      "Benchmark": {
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "metrics": {
               "items": {
                  "$ref": "#/$defs/RiskMetric"
               },
               "title": "Metrics",
               "type": "array"
            }
         },
         "required": [
            "name",
            "metrics"
         ],
         "title": "Benchmark",
         "type": "object"
      },
      "Risk": {
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "benchmarks": {
               "items": {
                  "$ref": "#/$defs/Benchmark"
               },
               "title": "Benchmarks",
               "type": "array"
            }
         },
         "required": [
            "name",
            "benchmarks"
         ],
         "title": "Risk",
         "type": "object"
      },
      "RiskMetric": {
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "number"
                     },
                     "type": "array"
                  }
               ],
               "title": "Value"
            }
         },
         "required": [
            "name",
            "value"
         ],
         "title": "RiskMetric",
         "type": "object"
      }
   },
   "required": [
      "risks"
   ]
}

Fields:

output_file_path (str | None)
risks (list[ibm_watsonx_gov.entities.model_risk_result.Risk])

field output_file_path: str | None = None¶

field risks: list[Risk] [Required]¶

to_json(**kwargs)¶: Transform the model risk result to a json. The kwargs are passed to the model_dump_json method of pydantic model. All the arguments supported by pydantic model_dump_json can be passed.

pydantic model ibm_watsonx_gov.entities.model_risk_result.Risk¶

Bases: BaseModel

Show JSON schema

{
   "title": "Risk",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "benchmarks": {
         "items": {
            "$ref": "#/$defs/Benchmark"
         },
         "title": "Benchmarks",
         "type": "array"
      }
   },
   "$defs": {
      "Benchmark": {
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "metrics": {
               "items": {
                  "$ref": "#/$defs/RiskMetric"
               },
               "title": "Metrics",
               "type": "array"
            }
         },
         "required": [
            "name",
            "metrics"
         ],
         "title": "Benchmark",
         "type": "object"
      },
      "RiskMetric": {
         "properties": {
            "name": {
               "title": "Name",
               "type": "string"
            },
            "value": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "type": "number"
                     },
                     "type": "array"
                  }
               ],
               "title": "Value"
            }
         },
         "required": [
            "name",
            "value"
         ],
         "title": "RiskMetric",
         "type": "object"
      }
   },
   "required": [
      "name",
      "benchmarks"
   ]
}

Fields:

benchmarks (list[ibm_watsonx_gov.entities.model_risk_result.Benchmark])
name (str)

field benchmarks: list[Benchmark] [Required]¶

field name: str [Required]¶

pydantic model ibm_watsonx_gov.entities.model_risk_result.RiskMetric¶

Bases: BaseModel

Show JSON schema

{
   "title": "RiskMetric",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "value": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "string"
            },
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            }
         ],
         "title": "Value"
      }
   },
   "required": [
      "name",
      "value"
   ]
}

Fields:

name (str)
value (float | str | List[float])

field name: str [Required]¶

field value: float | str | List[float] [Required]¶