Formats

Generated Pydantic models for shared.formats

pydantic model dakota.spec.shared.formats.MethodImportBuildFormatAnnotated

Selects annotated tabular file format

Show JSON schema

{
   "title": "MethodImportBuildFormatAnnotated",
   "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_build_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.formats.MethodImportBuildFormatCustomAnnotated

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodImportBuildFormatCustomAnnotated",
   "description": "Selects custom-annotated tabular file format",
   "type": "object",
   "properties": {
      "custom_annotated": {
         "$ref": "#/$defs/MethodImportBuildFormatCustomAnnotatedConfig",
         "x-materialization": [
            {
               "ir_key": "method.import_build_format",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "TABULAR_NONE"
            }
         ],
         "x-model-default": "MethodImportBuildFormatCustomAnnotatedConfig"
      }
   },
   "$defs": {
      "MethodImportBuildFormatCustomAnnotatedConfig": {
         "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_build_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_build_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_build_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodImportBuildFormatCustomAnnotatedConfig",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

custom_annotated (dakota.spec.shared.formats.MethodImportBuildFormatCustomAnnotatedConfig)

field custom_annotated: MethodImportBuildFormatCustomAnnotatedConfig [Optional]: Selects custom-annotated tabular file format

pydantic model dakota.spec.shared.formats.MethodImportBuildFormatCustomAnnotatedConfig

Selects custom-annotated tabular file format

Show JSON schema

{
   "title": "MethodImportBuildFormatCustomAnnotatedConfig",
   "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_build_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_build_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_build_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.formats.MethodImportBuildFormatFreeform

Selects freeform file format

Show JSON schema

{
   "title": "MethodImportBuildFormatFreeform",
   "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_build_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.formats.MethodImportBuildFormatMixin

Generated model for MethodImportBuildFormatMixin

Show JSON schema

{
   "title": "MethodImportBuildFormatMixin",
   "description": "Generated model for MethodImportBuildFormatMixin",
   "type": "object",
   "properties": {
      "format": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/MethodImportBuildFormatCustomAnnotated"
            },
            {
               "$ref": "#/$defs/MethodImportBuildFormatAnnotated"
            },
            {
               "$ref": "#/$defs/MethodImportBuildFormatFreeform"
            }
         ],
         "description": "Tabular Format",
         "title": "Format",
         "x-model-default": "MethodImportBuildFormatAnnotated",
         "x-union-pattern": 1
      }
   },
   "$defs": {
      "MethodImportBuildFormatAnnotated": {
         "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_build_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_ANNOTATED"
                  }
               ]
            }
         },
         "title": "MethodImportBuildFormatAnnotated",
         "type": "object"
      },
      "MethodImportBuildFormatCustomAnnotated": {
         "additionalProperties": false,
         "description": "Selects custom-annotated tabular file format",
         "properties": {
            "custom_annotated": {
               "$ref": "#/$defs/MethodImportBuildFormatCustomAnnotatedConfig",
               "x-materialization": [
                  {
                     "ir_key": "method.import_build_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ],
               "x-model-default": "MethodImportBuildFormatCustomAnnotatedConfig"
            }
         },
         "title": "MethodImportBuildFormatCustomAnnotated",
         "type": "object"
      },
      "MethodImportBuildFormatCustomAnnotatedConfig": {
         "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_build_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_build_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_build_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "TABULAR_IFACE_ID"
                  }
               ]
            }
         },
         "title": "MethodImportBuildFormatCustomAnnotatedConfig",
         "type": "object"
      },
      "MethodImportBuildFormatFreeform": {
         "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_build_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "PRESENCE_ENUM",
                     "stored_value": "TABULAR_NONE"
                  }
               ]
            }
         },
         "title": "MethodImportBuildFormatFreeform",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

format (dakota.spec.shared.formats.MethodImportBuildFormatCustomAnnotated | dakota.spec.shared.formats.MethodImportBuildFormatAnnotated | dakota.spec.shared.formats.MethodImportBuildFormatFreeform)

field format: MethodImportBuildFormatCustomAnnotated | MethodImportBuildFormatAnnotated | MethodImportBuildFormatFreeform [Optional]: Tabular Format

pydantic model dakota.spec.shared.formats.ModelFullSurfpackExportFormatExportModel

Exports surrogate model in user-specified format(s)

Show JSON schema

{
   "title": "ModelFullSurfpackExportFormatExportModel",
   "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/ModelFullSurfpackExportFormatFormats"
      }
   },
   "$defs": {
      "ModelFullSurfpackExportFormatFormats": {
         "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"
                  }
               ]
            },
            "algebraic_file": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Export surrogate model in algebraic format to a file",
               "title": "Algebraic File",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "ALGEBRAIC_FILE"
                  }
               ]
            },
            "algebraic_console": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Export surrogate model in algebraic format to the console",
               "title": "Algebraic Console",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "ALGEBRAIC_CONSOLE"
                  }
               ]
            }
         },
         "title": "ModelFullSurfpackExportFormatFormats",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "formats"
   ]
}

Fields:

filename_prefix (str)
formats (dakota.spec.shared.formats.ModelFullSurfpackExportFormatFormats)

field filename_prefix: str = 'exported_surrogate': User-customizable portion of exported/imported surrogate model filenames

field formats: ModelFullSurfpackExportFormatFormats [Required]: Formats for surrogate model export

pydantic model dakota.spec.shared.formats.ModelFullSurfpackExportFormatFormats

Formats for surrogate model export

Show JSON schema

{
   "title": "ModelFullSurfpackExportFormatFormats",
   "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"
            }
         ]
      },
      "algebraic_file": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Export surrogate model in algebraic format to a file",
         "title": "Algebraic File",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_export_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "ALGEBRAIC_FILE"
            }
         ]
      },
      "algebraic_console": {
         "anyOf": [
            {
               "const": true,
               "type": "boolean"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Export surrogate model in algebraic format to the console",
         "title": "Algebraic Console",
         "x-materialization": [
            {
               "ir_key": "model.surrogate.model_export_format",
               "ir_value_type": "unsigned short",
               "storage_type": "AUGMENT_ENUM",
               "stored_value": "ALGEBRAIC_CONSOLE"
            }
         ]
      }
   },
   "additionalProperties": false
}

Fields:

algebraic_console (Literal[True] | None)
algebraic_file (Literal[True] | None)
binary_archive (Literal[True] | None)
text_archive (Literal[True] | None)

field algebraic_console: Literal[True] | None = None: Export surrogate model in algebraic format to the console

field algebraic_file: Literal[True] | None = None: Export surrogate model in algebraic format to a file

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.formats.ModelFullSurfpackExportFormatMixin

Generated model for ModelFullSurfpackExportFormatMixin

Show JSON schema

{
   "title": "ModelFullSurfpackExportFormatMixin",
   "description": "Generated model for ModelFullSurfpackExportFormatMixin",
   "type": "object",
   "properties": {
      "export_model": {
         "anyOf": [
            {
               "$ref": "#/$defs/ModelFullSurfpackExportFormatExportModel"
            },
            {
               "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": {
      "ModelFullSurfpackExportFormatExportModel": {
         "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/ModelFullSurfpackExportFormatFormats"
            }
         },
         "required": [
            "formats"
         ],
         "title": "ModelFullSurfpackExportFormatExportModel",
         "type": "object"
      },
      "ModelFullSurfpackExportFormatFormats": {
         "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"
                  }
               ]
            },
            "algebraic_file": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Export surrogate model in algebraic format to a file",
               "title": "Algebraic File",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "ALGEBRAIC_FILE"
                  }
               ]
            },
            "algebraic_console": {
               "anyOf": [
                  {
                     "const": true,
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Export surrogate model in algebraic format to the console",
               "title": "Algebraic Console",
               "x-materialization": [
                  {
                     "ir_key": "model.surrogate.model_export_format",
                     "ir_value_type": "unsigned short",
                     "storage_type": "AUGMENT_ENUM",
                     "stored_value": "ALGEBRAIC_CONSOLE"
                  }
               ]
            }
         },
         "title": "ModelFullSurfpackExportFormatFormats",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:

export_model (dakota.spec.shared.formats.ModelFullSurfpackExportFormatExportModel | None)

field export_model: ModelFullSurfpackExportFormatExportModel | None = None: Exports surrogate model in user-specified format(s)

Formats

Exceptional service in the national interest