Surrogate

Generated Pydantic models for shared.surrogate

pydantic model dakota.spec.shared.surrogate.Additive

Additive correction factor for local surrogate accuracy

Show JSON schema

{
   "title": "Additive",
   "description": "Additive correction factor for local surrogate accuracy",
   "type": "object",
   "properties": {
      "additive": {
         "const": true,
         "default": true,
         "description": "Additive correction factor for local surrogate accuracy",
         "title": "Additive",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.correction_type",
               "ir_value_type": "short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "ADDITIVE_CORRECTION"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• additive (Literal[True])

field additive: Literal[True] = True

Additive correction factor for local surrogate accuracy

pydantic model dakota.spec.shared.surrogate.BinaryArchive

Surrogate model binary archive file format

Show JSON schema

{
   "title": "BinaryArchive",
   "description": "Surrogate model binary archive file format",
   "type": "object",
   "properties": {
      "binary_archive": {
         "const": true,
         "default": true,
         "description": "Surrogate model binary archive file format",
         "title": "Binary Archive",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "BINARY_ARCHIVE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• binary_archive (Literal[True])

field binary_archive: Literal[True] = True

Surrogate model binary archive file format

pydantic model dakota.spec.shared.surrogate.Correction

Correction approaches for surrogate models

Show JSON schema

{
   "title": "Correction",
   "description": "Correction approaches for surrogate models",
   "type": "object",
   "properties": {
      "correction_order": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/ZerothOrder"
            },
            {
               "$ref": "#/$defs/CorrectionFirstOrder"
            },
            {
               "$ref": "#/$defs/CorrectionSecondOrder"
            }
         ],
         "description": "Correction Order",
         "title": "Correction Order",
         "x-union-pattern": 4
      },
      "correction_type": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/Additive"
            },
            {
               "$ref": "#/$defs/Multiplicative"
            },
            {
               "$ref": "#/$defs/CorrectionCombined"
            }
         ],
         "description": "Correction Type",
         "title": "Correction Type",
         "x-union-pattern": 4
      }
   },
   "$defs": {
      "Additive": {
         "additionalProperties": false,
         "description": "Additive correction factor for local surrogate accuracy",
         "properties": {
            "additive": {
               "const": true,
               "default": true,
               "description": "Additive correction factor for local surrogate accuracy",
               "title": "Additive",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_type",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "ADDITIVE_CORRECTION"
                  }
               ]
            }
         },
         "title": "Additive",
         "type": "object"
      },
      "CorrectionCombined": {
         "additionalProperties": false,
         "description": "Multipoint correction for a hierarchical surrogate",
         "properties": {
            "combined": {
               "const": true,
               "default": true,
               "description": "Multipoint correction for a hierarchical surrogate",
               "title": "Combined",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_type",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "COMBINED_CORRECTION"
                  }
               ]
            }
         },
         "title": "CorrectionCombined",
         "type": "object"
      },
      "CorrectionFirstOrder": {
         "additionalProperties": false,
         "description": "Specify that truth values and gradients must be matched.",
         "properties": {
            "first_order": {
               "const": true,
               "default": true,
               "description": "Specify that truth values and gradients must be matched.",
               "title": "First Order",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_order",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": 1
                  }
               ]
            }
         },
         "title": "CorrectionFirstOrder",
         "type": "object"
      },
      "CorrectionSecondOrder": {
         "additionalProperties": false,
         "description": "Specify that truth values, gradients and Hessians must be matched.",
         "properties": {
            "second_order": {
               "const": true,
               "default": true,
               "description": "Specify that truth values, gradients and Hessians must be matched.",
               "title": "Second Order",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_order",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": 2
                  }
               ]
            }
         },
         "title": "CorrectionSecondOrder",
         "type": "object"
      },
      "Multiplicative": {
         "additionalProperties": false,
         "description": "Multiplicative correction factor for local surrogate accuracy.",
         "properties": {
            "multiplicative": {
               "const": true,
               "default": true,
               "description": "Multiplicative correction factor for local surrogate accuracy.",
               "title": "Multiplicative",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_type",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MULTIPLICATIVE_CORRECTION"
                  }
               ]
            }
         },
         "title": "Multiplicative",
         "type": "object"
      },
      "ZerothOrder": {
         "additionalProperties": false,
         "description": "Specify that truth values must be matched.",
         "properties": {
            "zeroth_order": {
               "const": true,
               "default": true,
               "description": "Specify that truth values must be matched.",
               "title": "Zeroth Order",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_order",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": 0
                  }
               ]
            }
         },
         "title": "ZerothOrder",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "correction_order",
      "correction_type"
   ]
}

Fields:

• correction_order (dakota.spec.shared.surrogate.ZerothOrder | dakota.spec.shared.surrogate.CorrectionFirstOrder | dakota.spec.shared.surrogate.CorrectionSecondOrder)

• correction_type (dakota.spec.shared.surrogate.Additive | dakota.spec.shared.surrogate.Multiplicative | dakota.spec.shared.surrogate.CorrectionCombined)

field correction_order: ZerothOrder | CorrectionFirstOrder | CorrectionSecondOrder [Required]

Correction Order

field correction_type: Additive | Multiplicative | CorrectionCombined [Required]

Correction Type

pydantic model dakota.spec.shared.surrogate.CorrectionCombined

Multipoint correction for a hierarchical surrogate

Show JSON schema

{
   "title": "CorrectionCombined",
   "description": "Multipoint correction for a hierarchical surrogate",
   "type": "object",
   "properties": {
      "combined": {
         "const": true,
         "default": true,
         "description": "Multipoint correction for a hierarchical surrogate",
         "title": "Combined",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.correction_type",
               "ir_value_type": "short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "COMBINED_CORRECTION"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• combined (Literal[True])

field combined: Literal[True] = True

Multipoint correction for a hierarchical surrogate

pydantic model dakota.spec.shared.surrogate.CorrectionFirstOrder

Specify that truth values and gradients must be matched.

Show JSON schema

{
   "title": "CorrectionFirstOrder",
   "description": "Specify that truth values and gradients must be matched.",
   "type": "object",
   "properties": {
      "first_order": {
         "const": true,
         "default": true,
         "description": "Specify that truth values and gradients must be matched.",
         "title": "First Order",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.correction_order",
               "ir_value_type": "short",
               "storage_type": "PRESENCE_LITERAL",
               "stored_value": 1
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• first_order (Literal[True])

field first_order: Literal[True] = True

Specify that truth values and gradients must be matched.

pydantic model dakota.spec.shared.surrogate.CorrectionSecondOrder

Specify that truth values, gradients and Hessians must be matched.

Show JSON schema

{
   "title": "CorrectionSecondOrder",
   "description": "Specify that truth values, gradients and Hessians must be matched.",
   "type": "object",
   "properties": {
      "second_order": {
         "const": true,
         "default": true,
         "description": "Specify that truth values, gradients and Hessians must be matched.",
         "title": "Second Order",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.correction_order",
               "ir_value_type": "short",
               "storage_type": "PRESENCE_LITERAL",
               "stored_value": 2
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• second_order (Literal[True])

field second_order: Literal[True] = True

Specify that truth values, gradients and Hessians must be matched.

pydantic model dakota.spec.shared.surrogate.ImportModel

Import surrogate model from archive file

Show JSON schema

{
   "title": "ImportModel",
   "description": "Import surrogate model from archive file",
   "type": "object",
   "properties": {
      "filename_prefix": {
         "default": "exported_surrogate",
         "description": "User-customizable portion of exported/imported surrogate model filenames",
         "title": "Filename Prefix",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_import_prefix",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "import_format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/TextArchive"
            },
            {
               "$ref": "#/$defs/BinaryArchive"
            }
         ],
         "description": "Surrogate Import Format",
         "title": "Import Format",
         "x-union-pattern": 4
      }
   },
   "$defs": {
      "BinaryArchive": {
         "additionalProperties": false,
         "description": "Surrogate model binary archive file format",
         "properties": {
            "binary_archive": {
               "const": true,
               "default": true,
               "description": "Surrogate model binary archive file format",
               "title": "Binary Archive",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "BINARY_ARCHIVE"
                  }
               ]
            }
         },
         "title": "BinaryArchive",
         "type": "object"
      },
      "TextArchive": {
         "additionalProperties": false,
         "description": "Surrogate model plain-text archive file format",
         "properties": {
            "text_archive": {
               "const": true,
               "default": true,
               "description": "Surrogate model plain-text archive file format",
               "title": "Text Archive",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TEXT_ARCHIVE"
                  }
               ]
            }
         },
         "title": "TextArchive",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "import_format"
   ]
}

Fields:

• filename_prefix (str)

• import_format (dakota.spec.shared.surrogate.TextArchive | dakota.spec.shared.surrogate.BinaryArchive)

field filename_prefix: str = 'exported_surrogate'

User-customizable portion of exported/imported surrogate model filenames

field import_format: TextArchive | BinaryArchive [Required]

Surrogate Import Format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxFormatAnnotated

Selects annotated tabular file format

Show JSON schema

{
   "title": "MethodExportApproxFormatAnnotated",
   "description": "Selects annotated tabular file format",
   "type": "object",
   "properties": {
      "annotated": {
         "const": true,
         "default": true,
         "description": "Selects annotated tabular file format",
         "title": "Annotated",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_ANNOTATED"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• annotated (Literal[True])

field annotated: Literal[True] = True

Selects annotated tabular file format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxFormatCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodExportApproxFormatCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/MethodExportApproxFormatCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "MethodExportApproxFormatCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "MethodExportApproxFormatCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodExportApproxFormatCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• custom_annotated (dakota.spec.shared.surrogate.MethodExportApproxFormatCustomAnnotatedConfig)

field custom_annotated: MethodExportApproxFormatCustomAnnotatedConfig [Optional]

Selects custom-annotated tabular file format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxFormatCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodExportApproxFormatCustomAnnotatedConfig",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "header": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable header row in custom-annotated tabular file",
         "title": "Header",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_HEADER"
            }
         ]
      },
      "eval_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable evaluation ID column in custom-annotated tabular file",
         "title": "Eval Id",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_EVAL_ID"
            }
         ]
      },
      "interface_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable interface ID column in custom-annotated tabular file",
         "title": "Interface Id",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_IFACE_ID"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• eval_id (Literal[True] | None)

• header (Literal[True] | None)

• interface_id (Literal[True] | None)

field eval_id: Literal[True] | None = None

Enable evaluation ID column in custom-annotated tabular file

field header: Literal[True] | None = None

Enable header row in custom-annotated tabular file

field interface_id: Literal[True] | None = None

Enable interface ID column in custom-annotated tabular file

pydantic model dakota.spec.shared.surrogate.MethodExportApproxFormatFreeform

Selects freeform file format

Show JSON schema

{
   "title": "MethodExportApproxFormatFreeform",
   "description": "Selects freeform file format",
   "type": "object",
   "properties": {
      "freeform": {
         "const": true,
         "default": true,
         "description": "Selects freeform file format",
         "title": "Freeform",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• freeform (Literal[True])

field freeform: Literal[True] = True

Selects freeform file format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxFormatMixin

Generated model for MethodExportApproxFormatMixin

Show JSON schema

{
   "title": "MethodExportApproxFormatMixin",
   "description": "Generated model for MethodExportApproxFormatMixin",
   "type": "object",
   "properties": {
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/MethodExportApproxFormatCustomAnnotated"
            },
            {
               "$ref": "#/$defs/MethodExportApproxFormatAnnotated"
            },
            {
               "$ref": "#/$defs/MethodExportApproxFormatFreeform"
            }
         ],
         "description": "Tabular Format",
         "title": "Format",
         "x-model-default": "MethodExportApproxFormatAnnotated",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "MethodExportApproxFormatAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "MethodExportApproxFormatAnnotated",
         "type": "object"
      },
      "MethodExportApproxFormatCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/MethodExportApproxFormatCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "MethodExportApproxFormatCustomAnnotatedConfig"
            }
         },
         "title": "MethodExportApproxFormatCustomAnnotated",
         "type": "object"
      },
      "MethodExportApproxFormatCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodExportApproxFormatCustomAnnotatedConfig",
         "type": "object"
      },
      "MethodExportApproxFormatFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "MethodExportApproxFormatFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• format (dakota.spec.shared.surrogate.MethodExportApproxFormatCustomAnnotated | dakota.spec.shared.surrogate.MethodExportApproxFormatAnnotated | dakota.spec.shared.surrogate.MethodExportApproxFormatFreeform)

field format: MethodExportApproxFormatCustomAnnotated | MethodExportApproxFormatAnnotated | MethodExportApproxFormatFreeform [Optional]

Tabular Format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxPointsFileAnnotated

Selects annotated tabular file format

Show JSON schema

{
   "title": "MethodExportApproxPointsFileAnnotated",
   "description": "Selects annotated tabular file format",
   "type": "object",
   "properties": {
      "annotated": {
         "const": true,
         "default": true,
         "description": "Selects annotated tabular file format",
         "title": "Annotated",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_ANNOTATED"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• annotated (Literal[True])

field annotated: Literal[True] = True

Selects annotated tabular file format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxPointsFileCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodExportApproxPointsFileCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/MethodExportApproxPointsFileCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "MethodExportApproxPointsFileCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "MethodExportApproxPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodExportApproxPointsFileCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• custom_annotated (dakota.spec.shared.surrogate.MethodExportApproxPointsFileCustomAnnotatedConfig)

field custom_annotated: MethodExportApproxPointsFileCustomAnnotatedConfig [Optional]

Selects custom-annotated tabular file format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxPointsFileCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodExportApproxPointsFileCustomAnnotatedConfig",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "header": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable header row in custom-annotated tabular file",
         "title": "Header",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_HEADER"
            }
         ]
      },
      "eval_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable evaluation ID column in custom-annotated tabular file",
         "title": "Eval Id",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_EVAL_ID"
            }
         ]
      },
      "interface_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable interface ID column in custom-annotated tabular file",
         "title": "Interface Id",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_IFACE_ID"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• eval_id (Literal[True] | None)

• header (Literal[True] | None)

• interface_id (Literal[True] | None)

field eval_id: Literal[True] | None = None

Enable evaluation ID column in custom-annotated tabular file

field header: Literal[True] | None = None

Enable header row in custom-annotated tabular file

field interface_id: Literal[True] | None = None

Enable interface ID column in custom-annotated tabular file

pydantic model dakota.spec.shared.surrogate.MethodExportApproxPointsFileExportApproxPointsFile

Output file for surrogate model value evaluations

Show JSON schema

{
   "title": "MethodExportApproxPointsFileExportApproxPointsFile",
   "description": "Output file for surrogate model value evaluations",
   "type": "object",
   "properties": {
      "filename": {
         "description": "Output file for surrogate model value evaluations",
         "title": "Filename",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_points_file",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/MethodExportApproxPointsFileCustomAnnotated"
            },
            {
               "$ref": "#/$defs/MethodExportApproxPointsFileAnnotated"
            },
            {
               "$ref": "#/$defs/MethodExportApproxPointsFileFreeform"
            }
         ],
         "description": "Tabular Format",
         "title": "Format",
         "x-model-default": "MethodExportApproxPointsFileAnnotated",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "MethodExportApproxPointsFileAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "MethodExportApproxPointsFileAnnotated",
         "type": "object"
      },
      "MethodExportApproxPointsFileCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/MethodExportApproxPointsFileCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "MethodExportApproxPointsFileCustomAnnotatedConfig"
            }
         },
         "title": "MethodExportApproxPointsFileCustomAnnotated",
         "type": "object"
      },
      "MethodExportApproxPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodExportApproxPointsFileCustomAnnotatedConfig",
         "type": "object"
      },
      "MethodExportApproxPointsFileFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "MethodExportApproxPointsFileFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "filename"
   ]
}

Fields:

• filename (str)

• format (dakota.spec.shared.surrogate.MethodExportApproxPointsFileCustomAnnotated | dakota.spec.shared.surrogate.MethodExportApproxPointsFileAnnotated | dakota.spec.shared.surrogate.MethodExportApproxPointsFileFreeform)

field filename: str [Required]

Output file for surrogate model value evaluations

field format: MethodExportApproxPointsFileCustomAnnotated | MethodExportApproxPointsFileAnnotated | MethodExportApproxPointsFileFreeform [Optional]

Tabular Format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxPointsFileFreeform

Selects freeform file format

Show JSON schema

{
   "title": "MethodExportApproxPointsFileFreeform",
   "description": "Selects freeform file format",
   "type": "object",
   "properties": {
      "freeform": {
         "const": true,
         "default": true,
         "description": "Selects freeform file format",
         "title": "Freeform",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.export_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• freeform (Literal[True])

field freeform: Literal[True] = True

Selects freeform file format

pydantic model dakota.spec.shared.surrogate.MethodExportApproxPointsFileMixin

Generated model for MethodExportApproxPointsFileMixin

Show JSON schema

{
   "title": "MethodExportApproxPointsFileMixin",
   "description": "Generated model for MethodExportApproxPointsFileMixin",
   "type": "object",
   "properties": {
      "export_approx_points_file": {
         "anyOf": [
            {
               "$ref": "#/$defs/MethodExportApproxPointsFileExportApproxPointsFile"
            },
            {
               "type": "null"
            }
         ],
         "argument": "filename",
         "default": null,
         "description": "Output file for surrogate model value evaluations",
         "x-aliases": [
            "export_points_file"
         ]
      }
   },
   "$defs": {
      "MethodExportApproxPointsFileAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "MethodExportApproxPointsFileAnnotated",
         "type": "object"
      },
      "MethodExportApproxPointsFileCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/MethodExportApproxPointsFileCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "MethodExportApproxPointsFileCustomAnnotatedConfig"
            }
         },
         "title": "MethodExportApproxPointsFileCustomAnnotated",
         "type": "object"
      },
      "MethodExportApproxPointsFileCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodExportApproxPointsFileCustomAnnotatedConfig",
         "type": "object"
      },
      "MethodExportApproxPointsFileExportApproxPointsFile": {
         "additionalProperties": false,
         "description": "Output file for surrogate model value evaluations",
         "properties": {
            "filename": {
               "description": "Output file for surrogate model value evaluations",
               "title": "Filename",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_points_file",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/MethodExportApproxPointsFileCustomAnnotated"
                  },
                  {
                     "$ref": "#/$defs/MethodExportApproxPointsFileAnnotated"
                  },
                  {
                     "$ref": "#/$defs/MethodExportApproxPointsFileFreeform"
                  }
               ],
               "description": "Tabular Format",
               "title": "Format",
               "x-model-default": "MethodExportApproxPointsFileAnnotated",
               "x-union-pattern": 1
            }
         },
         "required": [
            "filename"
         ],
         "title": "MethodExportApproxPointsFileExportApproxPointsFile",
         "type": "object"
      },
      "MethodExportApproxPointsFileFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.export_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "MethodExportApproxPointsFileFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• export_approx_points_file (dakota.spec.shared.surrogate.MethodExportApproxPointsFileExportApproxPointsFile | None)

field export_approx_points_file: MethodExportApproxPointsFileExportApproxPointsFile | None = None

Output file for surrogate model value evaluations

pydantic model dakota.spec.shared.surrogate.MethodImportApproxFormatAnnotated

Selects annotated tabular file format

Show JSON schema

{
   "title": "MethodImportApproxFormatAnnotated",
   "description": "Selects annotated tabular file format",
   "type": "object",
   "properties": {
      "annotated": {
         "const": true,
         "default": true,
         "description": "Selects annotated tabular file format",
         "title": "Annotated",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.import_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_ANNOTATED"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• annotated (Literal[True])

field annotated: Literal[True] = True

Selects annotated tabular file format

pydantic model dakota.spec.shared.surrogate.MethodImportApproxFormatCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodImportApproxFormatCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/MethodImportApproxFormatCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "method.import_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "MethodImportApproxFormatCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "MethodImportApproxFormatCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodImportApproxFormatCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• custom_annotated (dakota.spec.shared.surrogate.MethodImportApproxFormatCustomAnnotatedConfig)

field custom_annotated: MethodImportApproxFormatCustomAnnotatedConfig [Optional]

Selects custom-annotated tabular file format

pydantic model dakota.spec.shared.surrogate.MethodImportApproxFormatCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodImportApproxFormatCustomAnnotatedConfig",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "header": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable header row in custom-annotated tabular file",
         "title": "Header",
         "x-materialization": [
            {
               "ir_key": "method.import_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_HEADER"
            }
         ]
      },
      "eval_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable evaluation ID column in custom-annotated tabular file",
         "title": "Eval Id",
         "x-materialization": [
            {
               "ir_key": "method.import_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_EVAL_ID"
            }
         ]
      },
      "interface_id": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Enable interface ID column in custom-annotated tabular file",
         "title": "Interface Id",
         "x-materialization": [
            {
               "ir_key": "method.import_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TABULAR_IFACE_ID"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• eval_id (Literal[True] | None)

• header (Literal[True] | None)

• interface_id (Literal[True] | None)

field eval_id: Literal[True] | None = None

Enable evaluation ID column in custom-annotated tabular file

field header: Literal[True] | None = None

Enable header row in custom-annotated tabular file

field interface_id: Literal[True] | None = None

Enable interface ID column in custom-annotated tabular file

pydantic model dakota.spec.shared.surrogate.MethodImportApproxFormatFreeform

Selects freeform file format

Show JSON schema

{
   "title": "MethodImportApproxFormatFreeform",
   "description": "Selects freeform file format",
   "type": "object",
   "properties": {
      "freeform": {
         "const": true,
         "default": true,
         "description": "Selects freeform file format",
         "title": "Freeform",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "method.import_approx_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• freeform (Literal[True])

field freeform: Literal[True] = True

Selects freeform file format

pydantic model dakota.spec.shared.surrogate.MethodImportApproxFormatMixin

Generated model for MethodImportApproxFormatMixin

Show JSON schema

{
   "title": "MethodImportApproxFormatMixin",
   "description": "Generated model for MethodImportApproxFormatMixin",
   "type": "object",
   "properties": {
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/MethodImportApproxFormatCustomAnnotated"
            },
            {
               "$ref": "#/$defs/MethodImportApproxFormatAnnotated"
            },
            {
               "$ref": "#/$defs/MethodImportApproxFormatFreeform"
            }
         ],
         "description": "Tabular Format",
         "title": "Format",
         "x-model-default": "MethodImportApproxFormatAnnotated",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "MethodImportApproxFormatAnnotated": {
         "additionalProperties": false,
         "description": "Selects annotated tabular file format",
         "properties": {
            "annotated": {
               "const": true,
               "default": true,
               "description": "Selects annotated tabular file format",
               "title": "Annotated",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "MethodImportApproxFormatAnnotated",
         "type": "object"
      },
      "MethodImportApproxFormatCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/MethodImportApproxFormatCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "MethodImportApproxFormatCustomAnnotatedConfig"
            }
         },
         "title": "MethodImportApproxFormatCustomAnnotated",
         "type": "object"
      },
      "MethodImportApproxFormatCustomAnnotatedConfig": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "header": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable header row in custom-annotated tabular file",
               "title": "Header",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_HEADER"
                  }
               ]
            },
            "eval_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable evaluation ID column in custom-annotated tabular file",
               "title": "Eval Id",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_EVAL_ID"
                  }
               ]
            },
            "interface_id": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable interface ID column in custom-annotated tabular file",
               "title": "Interface Id",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodImportApproxFormatCustomAnnotatedConfig",
         "type": "object"
      },
      "MethodImportApproxFormatFreeform": {
         "additionalProperties": false,
         "description": "Selects freeform file format",
         "properties": {
            "freeform": {
               "const": true,
               "default": true,
               "description": "Selects freeform file format",
               "title": "Freeform",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "method.import_approx_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "MethodImportApproxFormatFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• format (dakota.spec.shared.surrogate.MethodImportApproxFormatCustomAnnotated | dakota.spec.shared.surrogate.MethodImportApproxFormatAnnotated | dakota.spec.shared.surrogate.MethodImportApproxFormatFreeform)

field format: MethodImportApproxFormatCustomAnnotated | MethodImportApproxFormatAnnotated | MethodImportApproxFormatFreeform [Optional]

Tabular Format

pydantic model dakota.spec.shared.surrogate.ModelPartialSurrogateExportFormatExportModel

Exports surrogate model in user-specified format(s)

Show JSON schema

{
   "title": "ModelPartialSurrogateExportFormatExportModel",
   "description": "Exports surrogate model in user-specified format(s)",
   "type": "object",
   "properties": {
      "filename_prefix": {
         "default": "exported_surrogate",
         "description": "User-customizable portion of exported/imported surrogate model filenames",
         "title": "Filename Prefix",
         "type": "string",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_export_prefix",
               "ir_value_type": "String",
               "storage_type": "DIRECT_VALUE"
            }
         ]
      },
      "formats": {
         "$ref": "#/$defs/ModelPartialSurrogateExportFormatFormats"
      }
   },
   "$defs": {
      "ModelPartialSurrogateExportFormatFormats": {
         "additionalProperties": false,
         "description": "Formats for surrogate model export",
         "properties": {
            "text_archive": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Surrogate model plain-text archive file format",
               "title": "Text Archive",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TEXT_ARCHIVE"
                  }
               ]
            },
            "binary_archive": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Surrogate model binary archive file format",
               "title": "Binary Archive",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "BINARY_ARCHIVE"
                  }
               ]
            }
         },
         "title": "ModelPartialSurrogateExportFormatFormats",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "formats"
   ]
}

Fields:

• filename_prefix (str)

• formats (dakota.spec.shared.surrogate.ModelPartialSurrogateExportFormatFormats)

field filename_prefix: str = 'exported_surrogate'

User-customizable portion of exported/imported surrogate model filenames

field formats: ModelPartialSurrogateExportFormatFormats [Required]

Formats for surrogate model export

pydantic model dakota.spec.shared.surrogate.ModelPartialSurrogateExportFormatFormats

Formats for surrogate model export

Show JSON schema

{
   "title": "ModelPartialSurrogateExportFormatFormats",
   "description": "Formats for surrogate model export",
   "type": "object",
   "properties": {
      "text_archive": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Surrogate model plain-text archive file format",
         "title": "Text Archive",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_export_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TEXT_ARCHIVE"
            }
         ]
      },
      "binary_archive": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Surrogate model binary archive file format",
         "title": "Binary Archive",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_export_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "BINARY_ARCHIVE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• binary_archive (Literal[True] | None)

• text_archive (Literal[True] | None)

field binary_archive: Literal[True] | None = None

Surrogate model binary archive file format

field text_archive: Literal[True] | None = None

Surrogate model plain-text archive file format

pydantic model dakota.spec.shared.surrogate.ModelPartialSurrogateExportFormatMixin

Generated model for ModelPartialSurrogateExportFormatMixin

Show JSON schema

{
   "title": "ModelPartialSurrogateExportFormatMixin",
   "description": "Generated model for ModelPartialSurrogateExportFormatMixin",
   "type": "object",
   "properties": {
      "export_model": {
         "anyOf": [
            {
               "$ref": "#/$defs/ModelPartialSurrogateExportFormatExportModel"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Exports surrogate model in user-specified format(s)",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.export_surrogate",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      }
   },
   "$defs": {
      "ModelPartialSurrogateExportFormatExportModel": {
         "additionalProperties": false,
         "description": "Exports surrogate model in user-specified format(s)",
         "properties": {
            "filename_prefix": {
               "default": "exported_surrogate",
               "description": "User-customizable portion of exported/imported surrogate model filenames",
               "title": "Filename Prefix",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_prefix",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "formats": {
               "$ref": "#/$defs/ModelPartialSurrogateExportFormatFormats"
            }
         },
         "required": [
            "formats"
         ],
         "title": "ModelPartialSurrogateExportFormatExportModel",
         "type": "object"
      },
      "ModelPartialSurrogateExportFormatFormats": {
         "additionalProperties": false,
         "description": "Formats for surrogate model export",
         "properties": {
            "text_archive": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Surrogate model plain-text archive file format",
               "title": "Text Archive",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TEXT_ARCHIVE"
                  }
               ]
            },
            "binary_archive": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Surrogate model binary archive file format",
               "title": "Binary Archive",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "BINARY_ARCHIVE"
                  }
               ]
            }
         },
         "title": "ModelPartialSurrogateExportFormatFormats",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• export_model (dakota.spec.shared.surrogate.ModelPartialSurrogateExportFormatExportModel | None)

field export_model: ModelPartialSurrogateExportFormatExportModel | None = None

Exports surrogate model in user-specified format(s)

pydantic model dakota.spec.shared.surrogate.ModelSurrogateImportMixin

Generated model for ModelSurrogateImportMixin

Show JSON schema

{
   "title": "ModelSurrogateImportMixin",
   "description": "Generated model for ModelSurrogateImportMixin",
   "type": "object",
   "properties": {
      "import_model": {
         "anyOf": [
            {
               "$ref": "#/$defs/ImportModel"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Import surrogate model from archive file",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.import_surrogate",
               "ir_value_type": "bool",
               "storage_type": "PRESENCE_TRUE"
            }
         ]
      }
   },
   "$defs": {
      "BinaryArchive": {
         "additionalProperties": false,
         "description": "Surrogate model binary archive file format",
         "properties": {
            "binary_archive": {
               "const": true,
               "default": true,
               "description": "Surrogate model binary archive file format",
               "title": "Binary Archive",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "BINARY_ARCHIVE"
                  }
               ]
            }
         },
         "title": "BinaryArchive",
         "type": "object"
      },
      "ImportModel": {
         "additionalProperties": false,
         "description": "Import surrogate model from archive file",
         "properties": {
            "filename_prefix": {
               "default": "exported_surrogate",
               "description": "User-customizable portion of exported/imported surrogate model filenames",
               "title": "Filename Prefix",
               "type": "string",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_import_prefix",
                     "ir_value_type": "String",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "import_format": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/TextArchive"
                  },
                  {
                     "$ref": "#/$defs/BinaryArchive"
                  }
               ],
               "description": "Surrogate Import Format",
               "title": "Import Format",
               "x-union-pattern": 4
            }
         },
         "required": [
            "import_format"
         ],
         "title": "ImportModel",
         "type": "object"
      },
      "TextArchive": {
         "additionalProperties": false,
         "description": "Surrogate model plain-text archive file format",
         "properties": {
            "text_archive": {
               "const": true,
               "default": true,
               "description": "Surrogate model plain-text archive file format",
               "title": "Text Archive",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_import_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TEXT_ARCHIVE"
                  }
               ]
            }
         },
         "title": "TextArchive",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• import_model (dakota.spec.shared.surrogate.ImportModel | None)

field import_model: ImportModel | None = None

Import surrogate model from archive file

pydantic model dakota.spec.shared.surrogate.Multiplicative

Multiplicative correction factor for local surrogate accuracy.

Show JSON schema

{
   "title": "Multiplicative",
   "description": "Multiplicative correction factor for local surrogate accuracy.",
   "type": "object",
   "properties": {
      "multiplicative": {
         "const": true,
         "default": true,
         "description": "Multiplicative correction factor for local surrogate accuracy.",
         "title": "Multiplicative",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.correction_type",
               "ir_value_type": "short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "MULTIPLICATIVE_CORRECTION"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• multiplicative (Literal[True])

field multiplicative: Literal[True] = True

Multiplicative correction factor for local surrogate accuracy.

pydantic model dakota.spec.shared.surrogate.SurrogateCorrectionMixin

Generated model for SurrogateCorrectionMixin

Show JSON schema

{
   "title": "SurrogateCorrectionMixin",
   "description": "Generated model for SurrogateCorrectionMixin",
   "type": "object",
   "properties": {
      "correction": {
         "anyOf": [
            {
               "$ref": "#/$defs/Correction"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Correction approaches for surrogate models"
      }
   },
   "$defs": {
      "Additive": {
         "additionalProperties": false,
         "description": "Additive correction factor for local surrogate accuracy",
         "properties": {
            "additive": {
               "const": true,
               "default": true,
               "description": "Additive correction factor for local surrogate accuracy",
               "title": "Additive",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_type",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "ADDITIVE_CORRECTION"
                  }
               ]
            }
         },
         "title": "Additive",
         "type": "object"
      },
      "Correction": {
         "additionalProperties": false,
         "description": "Correction approaches for surrogate models",
         "properties": {
            "correction_order": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/ZerothOrder"
                  },
                  {
                     "$ref": "#/$defs/CorrectionFirstOrder"
                  },
                  {
                     "$ref": "#/$defs/CorrectionSecondOrder"
                  }
               ],
               "description": "Correction Order",
               "title": "Correction Order",
               "x-union-pattern": 4
            },
            "correction_type": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/Additive"
                  },
                  {
                     "$ref": "#/$defs/Multiplicative"
                  },
                  {
                     "$ref": "#/$defs/CorrectionCombined"
                  }
               ],
               "description": "Correction Type",
               "title": "Correction Type",
               "x-union-pattern": 4
            }
         },
         "required": [
            "correction_order",
            "correction_type"
         ],
         "title": "Correction",
         "type": "object"
      },
      "CorrectionCombined": {
         "additionalProperties": false,
         "description": "Multipoint correction for a hierarchical surrogate",
         "properties": {
            "combined": {
               "const": true,
               "default": true,
               "description": "Multipoint correction for a hierarchical surrogate",
               "title": "Combined",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_type",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "COMBINED_CORRECTION"
                  }
               ]
            }
         },
         "title": "CorrectionCombined",
         "type": "object"
      },
      "CorrectionFirstOrder": {
         "additionalProperties": false,
         "description": "Specify that truth values and gradients must be matched.",
         "properties": {
            "first_order": {
               "const": true,
               "default": true,
               "description": "Specify that truth values and gradients must be matched.",
               "title": "First Order",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_order",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": 1
                  }
               ]
            }
         },
         "title": "CorrectionFirstOrder",
         "type": "object"
      },
      "CorrectionSecondOrder": {
         "additionalProperties": false,
         "description": "Specify that truth values, gradients and Hessians must be matched.",
         "properties": {
            "second_order": {
               "const": true,
               "default": true,
               "description": "Specify that truth values, gradients and Hessians must be matched.",
               "title": "Second Order",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_order",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": 2
                  }
               ]
            }
         },
         "title": "CorrectionSecondOrder",
         "type": "object"
      },
      "Multiplicative": {
         "additionalProperties": false,
         "description": "Multiplicative correction factor for local surrogate accuracy.",
         "properties": {
            "multiplicative": {
               "const": true,
               "default": true,
               "description": "Multiplicative correction factor for local surrogate accuracy.",
               "title": "Multiplicative",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_type",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "MULTIPLICATIVE_CORRECTION"
                  }
               ]
            }
         },
         "title": "Multiplicative",
         "type": "object"
      },
      "ZerothOrder": {
         "additionalProperties": false,
         "description": "Specify that truth values must be matched.",
         "properties": {
            "zeroth_order": {
               "const": true,
               "default": true,
               "description": "Specify that truth values must be matched.",
               "title": "Zeroth Order",
               "type": "boolean",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.correction_order",
                     "ir_value_type": "short",
                     "storage_type": "PRESENCE_LITERAL",
                     "stored_value": 0
                  }
               ]
            }
         },
         "title": "ZerothOrder",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

• correction (dakota.spec.shared.surrogate.Correction | None)

field correction: Correction | None = None

Correction approaches for surrogate models

pydantic model dakota.spec.shared.surrogate.TextArchive

Surrogate model plain-text archive file format

Show JSON schema

{
   "title": "TextArchive",
   "description": "Surrogate model plain-text archive file format",
   "type": "object",
   "properties": {
      "text_archive": {
         "const": true,
         "default": true,
         "description": "Surrogate model plain-text archive file format",
         "title": "Text Archive",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_import_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "TEXT_ARCHIVE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• text_archive (Literal[True])

field text_archive: Literal[True] = True

Surrogate model plain-text archive file format

pydantic model dakota.spec.shared.surrogate.ZerothOrder

Specify that truth values must be matched.

Show JSON schema

{
   "title": "ZerothOrder",
   "description": "Specify that truth values must be matched.",
   "type": "object",
   "properties": {
      "zeroth_order": {
         "const": true,
         "default": true,
         "description": "Specify that truth values must be matched.",
         "title": "Zeroth Order",
         "type": "boolean",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.correction_order",
               "ir_value_type": "short",
               "storage_type": "PRESENCE_LITERAL",
               "stored_value": 0
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

• zeroth_order (Literal[True])

field zeroth_order: Literal[True] = True

Specify that truth values must be matched.