efficient_global
- pydantic model dakota.spec.method.efficient_global.EfficientGlobalSelection
Generated model for EfficientGlobalSelection
Show JSON schema
{ "title": "EfficientGlobalSelection", "description": "Generated model for EfficientGlobalSelection", "type": "object", "properties": { "efficient_global": { "$ref": "#/$defs/EfficientGlobalConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "EFFICIENT_GLOBAL" } ] } }, "$defs": { "BatchSize": { "additionalProperties": false, "description": "Total batch size in parallel EGO", "properties": { "synchronization": { "anyOf": [ { "$ref": "#/$defs/Blocking" }, { "$ref": "#/$defs/Nonblocking" }, { "type": "null" } ], "default": null, "description": "Select how Dakota schedules a batch of concurrent function evaluations in a parallel algorithm", "title": "Synchronization", "x-union-pattern": 2 }, "count": { "default": 1, "description": "Total batch size in parallel EGO", "minimum": 1, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "method.batch_size", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "exploration": { "default": 0, "description": "Portion of batch size dedicated to exploration in parallel EGO", "minimum": 0, "title": "Exploration", "type": "integer", "x-materialization": [ { "ir_key": "method.batch_size.exploration", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "BatchSize", "type": "object" }, "Blocking": { "additionalProperties": false, "description": "Complete concurrent evaluation of all evaluations within a batch", "properties": { "blocking": { "const": true, "default": true, "description": "Complete concurrent evaluation of all evaluations within a batch", "title": "Blocking", "type": "boolean", "x-materialization": [ { "ir_key": "method.synchronization", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "BLOCKING_SYNCHRONIZATION" } ] } }, "title": "Blocking", "type": "object" }, "Debug": { "additionalProperties": false, "description": "Level 5 of 5 - maximum", "properties": { "debug": { "const": true, "default": true, "description": "Level 5 of 5 - maximum", "title": "Debug", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEBUG_OUTPUT" } ] } }, "title": "Debug", "type": "object" }, "EfficientGlobalConfig": { "additionalProperties": false, "description": "Global Surrogate Based Optimization, a.k.a. EGO", "properties": { "model_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "gaussian_process": { "anyOf": [ { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpack" }, { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPDakota" }, { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPExperimental" }, { "type": "null" } ], "default": null, "description": "Gaussian Process surrogate model", "title": "Gaussian Process", "x-aliases": [ "kriging" ], "x-union-pattern": 2 }, "max_iterations": { "default": 9223372036854775807, "description": "Number of iterations allowed for optimizers and adaptive UQ methods", "minimum": 0, "title": "Max Iterations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_iterations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "id_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the method block; helpful when there are multiple", "title": "Id Method", "x-materialization": [ { "ir_key": "method.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output": { "anyOf": [ { "$ref": "#/$defs/Debug" }, { "$ref": "#/$defs/Verbose" }, { "$ref": "#/$defs/Normal" }, { "$ref": "#/$defs/Quiet" }, { "$ref": "#/$defs/Silent" } ], "description": "Control how much method information is written to the screen and output file", "title": "Output", "x-model-default": "Normal", "x-union-pattern": 1 }, "final_solutions": { "default": 0, "description": "Number of designs returned as the best solutions", "minimum": 0, "title": "Final Solutions", "type": "integer", "x-materialization": [ { "ir_key": "method.final_solutions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "initial_samples": { "default": 0, "description": "Initial number of samples for sampling-based methods", "title": "Initial Samples", "type": "integer", "x-materialization": [ { "ir_key": "method.samples", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "seed": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Seed of the random number generator", "title": "Seed", "x-materialization": [ { "ir_key": "method.random_seed", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "batch_size": { "anyOf": [ { "$ref": "#/$defs/BatchSize" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Total batch size in parallel EGO" }, "convergence_tolerance": { "default": -1.7976931348623157e+308, "description": "Expected improvement convergence tolerance", "title": "Convergence Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.convergence_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" }, { "ir_key": "method.jega.percent_change", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "x_conv_tol": { "default": -1.0, "description": "x-convergence tolerance", "title": "X Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.x_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "use_derivatives": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Use derivative data to construct surrogate models", "title": "Use Derivatives", "x-materialization": [ { "ir_key": "method.derivative_usage", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "import_build_points_file": { "anyOf": [ { "$ref": "#/$defs/EfficientGlobalImportBuildPointsFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "File containing points you wish to use to build a surrogate", "x-aliases": [ "import_points_file" ] }, "export_approx_points_file": { "anyOf": [ { "$ref": "#/$defs/EfficientGlobalExportApproxPointsFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "Output file for surrogate model value evaluations", "x-aliases": [ "export_points_file" ] } }, "title": "EfficientGlobalConfig", "type": "object" }, "EfficientGlobalExportApproxPointsFile": { "additionalProperties": false, "description": "Output file for surrogate model value evaluations", "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 }, "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" } ] } }, "required": [ "filename" ], "title": "EfficientGlobalExportApproxPointsFile", "type": "object" }, "EfficientGlobalImportBuildPointsFile": { "additionalProperties": false, "description": "File containing points you wish to use to build a surrogate", "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 }, "filename": { "description": "File containing points you wish to use to build a surrogate", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "method.import_build_points_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "active_only": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Import only active variables from tabular data file", "title": "Active Only", "x-materialization": [ { "ir_key": "method.import_build_active_only", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "filename" ], "title": "EfficientGlobalImportBuildPointsFile", "type": "object" }, "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" }, "MethodGpAlternativesWithExportContext2GPDakota": { "additionalProperties": false, "description": "Select the built in Gaussian Process surrogate", "properties": { "dakota": { "const": true, "default": true, "description": "Select the built in Gaussian Process surrogate", "title": "Dakota", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.emulator", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "GP_EMULATOR" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPDakota", "type": "object" }, "MethodGpAlternativesWithExportContext2GPExperimental": { "additionalProperties": false, "description": "Use the experimental Gaussian Process surrogate", "properties": { "experimental": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPExperimentalConfig", "x-materialization": [ { "ir_key": "method.nond.emulator", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "EXPGP_EMULATOR" } ] } }, "required": [ "experimental" ], "title": "MethodGpAlternativesWithExportContext2GPExperimental", "type": "object" }, "MethodGpAlternativesWithExportContext2GPExperimentalConfig": { "additionalProperties": false, "description": "Use the experimental Gaussian Process surrogate", "properties": { "export_model": { "anyOf": [ { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPExperimentalExportModel" }, { "type": "null" } ], "default": null, "description": "Exports surrogate model in user-specified format(s)", "x-materialization": [ { "ir_key": "method.export_surrogate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "options_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filename for a YAML file that specifies Gaussian process options", "title": "Options File", "x-materialization": [ { "ir_key": "method.advanced_options_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPExperimentalConfig", "type": "object" }, "MethodGpAlternativesWithExportContext2GPExperimentalExportModel": { "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": "method.model_export_prefix", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "formats": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats" } }, "required": [ "formats" ], "title": "MethodGpAlternativesWithExportContext2GPExperimentalExportModel", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpack": { "additionalProperties": false, "description": "Use the Surfpack version of Gaussian Process surrogates", "properties": { "surfpack": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackConfig", "x-materialization": [ { "ir_key": "method.nond.emulator", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "KRIGING_EMULATOR" } ] } }, "required": [ "surfpack" ], "title": "MethodGpAlternativesWithExportContext2GPSurfpack", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpackConfig": { "additionalProperties": false, "description": "Use the Surfpack version of Gaussian Process surrogates", "properties": { "export_model": { "anyOf": [ { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackExportModel" }, { "type": "null" } ], "default": null, "description": "Exports surrogate model in user-specified format(s)", "x-materialization": [ { "ir_key": "method.export_surrogate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPSurfpackConfig", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpackExportModel": { "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": "method.model_export_prefix", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "formats": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats" } }, "required": [ "formats" ], "title": "MethodGpAlternativesWithExportContext2GPSurfpackExportModel", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats": { "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": "method.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": "method.model_export_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "BINARY_ARCHIVE" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats", "type": "object" }, "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" }, "Nonblocking": { "additionalProperties": false, "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm", "properties": { "nonblocking": { "const": true, "default": true, "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm", "title": "Nonblocking", "type": "boolean", "x-materialization": [ { "ir_key": "method.synchronization", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NONBLOCKING_SYNCHRONIZATION" } ] } }, "title": "Nonblocking", "type": "object" }, "Normal": { "additionalProperties": false, "description": "Level 3 of 5 - default", "properties": { "normal": { "const": true, "default": true, "description": "Level 3 of 5 - default", "title": "Normal", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NORMAL_OUTPUT" } ] } }, "title": "Normal", "type": "object" }, "Quiet": { "additionalProperties": false, "description": "Level 2 of 5 - less than normal", "properties": { "quiet": { "const": true, "default": true, "description": "Level 2 of 5 - less than normal", "title": "Quiet", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "QUIET_OUTPUT" } ] } }, "title": "Quiet", "type": "object" }, "Silent": { "additionalProperties": false, "description": "Level 1 of 5 - minimum", "properties": { "silent": { "const": true, "default": true, "description": "Level 1 of 5 - minimum", "title": "Silent", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SILENT_OUTPUT" } ] } }, "title": "Silent", "type": "object" }, "Verbose": { "additionalProperties": false, "description": "Level 4 of 5 - more than normal", "properties": { "verbose": { "const": true, "default": true, "description": "Level 4 of 5 - more than normal", "title": "Verbose", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "VERBOSE_OUTPUT" } ] } }, "title": "Verbose", "type": "object" } }, "additionalProperties": false, "required": [ "efficient_global" ] }
- field efficient_global: EfficientGlobalConfig [Required]
- classmethod get_registry() dict[str, type[MethodSelection]]
Get registry, performing deferred registration on first call
- classmethod get_union()
Generate Union from all registered selections
- pydantic model dakota.spec.method.efficient_global.EfficientGlobalConfig
Global Surrogate Based Optimization, a.k.a. EGO
Show JSON schema
{ "title": "EfficientGlobalConfig", "description": "Global Surrogate Based Optimization, a.k.a. EGO", "type": "object", "properties": { "model_pointer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "gaussian_process": { "anyOf": [ { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpack" }, { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPDakota" }, { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPExperimental" }, { "type": "null" } ], "default": null, "description": "Gaussian Process surrogate model", "title": "Gaussian Process", "x-aliases": [ "kriging" ], "x-union-pattern": 2 }, "max_iterations": { "default": 9223372036854775807, "description": "Number of iterations allowed for optimizers and adaptive UQ methods", "minimum": 0, "title": "Max Iterations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_iterations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "id_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the method block; helpful when there are multiple", "title": "Id Method", "x-materialization": [ { "ir_key": "method.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "output": { "anyOf": [ { "$ref": "#/$defs/Debug" }, { "$ref": "#/$defs/Verbose" }, { "$ref": "#/$defs/Normal" }, { "$ref": "#/$defs/Quiet" }, { "$ref": "#/$defs/Silent" } ], "description": "Control how much method information is written to the screen and output file", "title": "Output", "x-model-default": "Normal", "x-union-pattern": 1 }, "final_solutions": { "default": 0, "description": "Number of designs returned as the best solutions", "minimum": 0, "title": "Final Solutions", "type": "integer", "x-materialization": [ { "ir_key": "method.final_solutions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "initial_samples": { "default": 0, "description": "Initial number of samples for sampling-based methods", "title": "Initial Samples", "type": "integer", "x-materialization": [ { "ir_key": "method.samples", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "seed": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Seed of the random number generator", "title": "Seed", "x-materialization": [ { "ir_key": "method.random_seed", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "batch_size": { "anyOf": [ { "$ref": "#/$defs/BatchSize" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Total batch size in parallel EGO" }, "convergence_tolerance": { "default": -1.7976931348623157e+308, "description": "Expected improvement convergence tolerance", "title": "Convergence Tolerance", "type": "number", "x-materialization": [ { "ir_key": "method.convergence_tolerance", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" }, { "ir_key": "method.jega.percent_change", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "x_conv_tol": { "default": -1.0, "description": "x-convergence tolerance", "title": "X Conv Tol", "type": "number", "x-materialization": [ { "ir_key": "method.x_conv_tol", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "use_derivatives": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Use derivative data to construct surrogate models", "title": "Use Derivatives", "x-materialization": [ { "ir_key": "method.derivative_usage", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "import_build_points_file": { "anyOf": [ { "$ref": "#/$defs/EfficientGlobalImportBuildPointsFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "File containing points you wish to use to build a surrogate", "x-aliases": [ "import_points_file" ] }, "export_approx_points_file": { "anyOf": [ { "$ref": "#/$defs/EfficientGlobalExportApproxPointsFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "Output file for surrogate model value evaluations", "x-aliases": [ "export_points_file" ] } }, "$defs": { "BatchSize": { "additionalProperties": false, "description": "Total batch size in parallel EGO", "properties": { "synchronization": { "anyOf": [ { "$ref": "#/$defs/Blocking" }, { "$ref": "#/$defs/Nonblocking" }, { "type": "null" } ], "default": null, "description": "Select how Dakota schedules a batch of concurrent function evaluations in a parallel algorithm", "title": "Synchronization", "x-union-pattern": 2 }, "count": { "default": 1, "description": "Total batch size in parallel EGO", "minimum": 1, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "method.batch_size", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "exploration": { "default": 0, "description": "Portion of batch size dedicated to exploration in parallel EGO", "minimum": 0, "title": "Exploration", "type": "integer", "x-materialization": [ { "ir_key": "method.batch_size.exploration", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "title": "BatchSize", "type": "object" }, "Blocking": { "additionalProperties": false, "description": "Complete concurrent evaluation of all evaluations within a batch", "properties": { "blocking": { "const": true, "default": true, "description": "Complete concurrent evaluation of all evaluations within a batch", "title": "Blocking", "type": "boolean", "x-materialization": [ { "ir_key": "method.synchronization", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "BLOCKING_SYNCHRONIZATION" } ] } }, "title": "Blocking", "type": "object" }, "Debug": { "additionalProperties": false, "description": "Level 5 of 5 - maximum", "properties": { "debug": { "const": true, "default": true, "description": "Level 5 of 5 - maximum", "title": "Debug", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEBUG_OUTPUT" } ] } }, "title": "Debug", "type": "object" }, "EfficientGlobalExportApproxPointsFile": { "additionalProperties": false, "description": "Output file for surrogate model value evaluations", "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 }, "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" } ] } }, "required": [ "filename" ], "title": "EfficientGlobalExportApproxPointsFile", "type": "object" }, "EfficientGlobalImportBuildPointsFile": { "additionalProperties": false, "description": "File containing points you wish to use to build a surrogate", "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 }, "filename": { "description": "File containing points you wish to use to build a surrogate", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "method.import_build_points_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "active_only": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Import only active variables from tabular data file", "title": "Active Only", "x-materialization": [ { "ir_key": "method.import_build_active_only", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "filename" ], "title": "EfficientGlobalImportBuildPointsFile", "type": "object" }, "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" }, "MethodGpAlternativesWithExportContext2GPDakota": { "additionalProperties": false, "description": "Select the built in Gaussian Process surrogate", "properties": { "dakota": { "const": true, "default": true, "description": "Select the built in Gaussian Process surrogate", "title": "Dakota", "type": "boolean", "x-materialization": [ { "ir_key": "method.nond.emulator", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "GP_EMULATOR" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPDakota", "type": "object" }, "MethodGpAlternativesWithExportContext2GPExperimental": { "additionalProperties": false, "description": "Use the experimental Gaussian Process surrogate", "properties": { "experimental": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPExperimentalConfig", "x-materialization": [ { "ir_key": "method.nond.emulator", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "EXPGP_EMULATOR" } ] } }, "required": [ "experimental" ], "title": "MethodGpAlternativesWithExportContext2GPExperimental", "type": "object" }, "MethodGpAlternativesWithExportContext2GPExperimentalConfig": { "additionalProperties": false, "description": "Use the experimental Gaussian Process surrogate", "properties": { "export_model": { "anyOf": [ { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPExperimentalExportModel" }, { "type": "null" } ], "default": null, "description": "Exports surrogate model in user-specified format(s)", "x-materialization": [ { "ir_key": "method.export_surrogate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "options_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Filename for a YAML file that specifies Gaussian process options", "title": "Options File", "x-materialization": [ { "ir_key": "method.advanced_options_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPExperimentalConfig", "type": "object" }, "MethodGpAlternativesWithExportContext2GPExperimentalExportModel": { "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": "method.model_export_prefix", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "formats": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats" } }, "required": [ "formats" ], "title": "MethodGpAlternativesWithExportContext2GPExperimentalExportModel", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpack": { "additionalProperties": false, "description": "Use the Surfpack version of Gaussian Process surrogates", "properties": { "surfpack": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackConfig", "x-materialization": [ { "ir_key": "method.nond.emulator", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "KRIGING_EMULATOR" } ] } }, "required": [ "surfpack" ], "title": "MethodGpAlternativesWithExportContext2GPSurfpack", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpackConfig": { "additionalProperties": false, "description": "Use the Surfpack version of Gaussian Process surrogates", "properties": { "export_model": { "anyOf": [ { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackExportModel" }, { "type": "null" } ], "default": null, "description": "Exports surrogate model in user-specified format(s)", "x-materialization": [ { "ir_key": "method.export_surrogate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPSurfpackConfig", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpackExportModel": { "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": "method.model_export_prefix", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "formats": { "$ref": "#/$defs/MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats" } }, "required": [ "formats" ], "title": "MethodGpAlternativesWithExportContext2GPSurfpackExportModel", "type": "object" }, "MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats": { "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": "method.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": "method.model_export_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "BINARY_ARCHIVE" } ] } }, "title": "MethodGpAlternativesWithExportContext2GPSurfpackExportModelFormats", "type": "object" }, "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" }, "Nonblocking": { "additionalProperties": false, "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm", "properties": { "nonblocking": { "const": true, "default": true, "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm", "title": "Nonblocking", "type": "boolean", "x-materialization": [ { "ir_key": "method.synchronization", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NONBLOCKING_SYNCHRONIZATION" } ] } }, "title": "Nonblocking", "type": "object" }, "Normal": { "additionalProperties": false, "description": "Level 3 of 5 - default", "properties": { "normal": { "const": true, "default": true, "description": "Level 3 of 5 - default", "title": "Normal", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NORMAL_OUTPUT" } ] } }, "title": "Normal", "type": "object" }, "Quiet": { "additionalProperties": false, "description": "Level 2 of 5 - less than normal", "properties": { "quiet": { "const": true, "default": true, "description": "Level 2 of 5 - less than normal", "title": "Quiet", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "QUIET_OUTPUT" } ] } }, "title": "Quiet", "type": "object" }, "Silent": { "additionalProperties": false, "description": "Level 1 of 5 - minimum", "properties": { "silent": { "const": true, "default": true, "description": "Level 1 of 5 - minimum", "title": "Silent", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "SILENT_OUTPUT" } ] } }, "title": "Silent", "type": "object" }, "Verbose": { "additionalProperties": false, "description": "Level 4 of 5 - more than normal", "properties": { "verbose": { "const": true, "default": true, "description": "Level 4 of 5 - more than normal", "title": "Verbose", "type": "boolean", "x-materialization": [ { "ir_key": "method.output", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "VERBOSE_OUTPUT" } ] } }, "title": "Verbose", "type": "object" } }, "additionalProperties": false }
- field convergence_tolerance: DakotaFloat = -1.7976931348623157e+308
Expected improvement convergence tolerance
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
- field export_approx_points_file: EfficientGlobalExportApproxPointsFile | None = None
Output file for surrogate model value evaluations
- field final_solutions: int = 0
Number of designs returned as the best solutions
- Constraints:
ge = 0
- field gaussian_process: MethodGpAlternativesWithExportContext2GPSurfpack | MethodGpAlternativesWithExportContext2GPDakota | MethodGpAlternativesWithExportContext2GPExperimental | None = None
Gaussian Process surrogate model
- field id_method: str | None = None
Name the method block; helpful when there are multiple
- field import_build_points_file: EfficientGlobalImportBuildPointsFile | None = None
File containing points you wish to use to build a surrogate
- field initial_samples: int = 0
Initial number of samples for sampling-based methods
- field max_iterations: int = 9223372036854775807
Number of iterations allowed for optimizers and adaptive UQ methods
- Constraints:
ge = 0
- field model_pointer: str | None = None
Identifier for model block to be used by a method
- field output: Debug | Verbose | Normal | Quiet | Silent [Optional]
Control how much method information is written to the screen and output file
- field seed: int | None = None
Seed of the random number generator
- Constraints:
gt = 0
- field use_derivatives: Literal[True] | None = None
Use derivative data to construct surrogate models
- field x_conv_tol: DakotaFloat = -1.0
x-convergence tolerance
- Constraints:
func = <function _serialize_dakota_float at 0x7f2a3de76700>
return_type = float | str
when_used = json
Generated Pydantic models for method.efficient_global
- pydantic model dakota.spec.method.efficient_global.BatchSize
Total batch size in parallel EGO
Show JSON schema
{ "title": "BatchSize", "description": "Total batch size in parallel EGO", "type": "object", "properties": { "synchronization": { "anyOf": [ { "$ref": "#/$defs/Blocking" }, { "$ref": "#/$defs/Nonblocking" }, { "type": "null" } ], "default": null, "description": "Select how Dakota schedules a batch of concurrent function evaluations in a parallel algorithm", "title": "Synchronization", "x-union-pattern": 2 }, "count": { "default": 1, "description": "Total batch size in parallel EGO", "minimum": 1, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "method.batch_size", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "exploration": { "default": 0, "description": "Portion of batch size dedicated to exploration in parallel EGO", "minimum": 0, "title": "Exploration", "type": "integer", "x-materialization": [ { "ir_key": "method.batch_size.exploration", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "Blocking": { "additionalProperties": false, "description": "Complete concurrent evaluation of all evaluations within a batch", "properties": { "blocking": { "const": true, "default": true, "description": "Complete concurrent evaluation of all evaluations within a batch", "title": "Blocking", "type": "boolean", "x-materialization": [ { "ir_key": "method.synchronization", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "BLOCKING_SYNCHRONIZATION" } ] } }, "title": "Blocking", "type": "object" }, "Nonblocking": { "additionalProperties": false, "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm", "properties": { "nonblocking": { "const": true, "default": true, "description": "A batch of concurrent evaluations are queried for completions and a partial set is returned to the algorithm", "title": "Nonblocking", "type": "boolean", "x-materialization": [ { "ir_key": "method.synchronization", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "NONBLOCKING_SYNCHRONIZATION" } ] } }, "title": "Nonblocking", "type": "object" } }, "additionalProperties": false }
- Fields:
- field count: int = 1
Total batch size in parallel EGO
- Constraints:
ge = 1
- field exploration: int = 0
Portion of batch size dedicated to exploration in parallel EGO
- Constraints:
ge = 0
- field synchronization: Blocking | Nonblocking | None = None
Select how Dakota schedules a batch of concurrent function evaluations in a parallel algorithm
- pydantic model dakota.spec.method.efficient_global.EfficientGlobalExportApproxPointsFile
Output file for surrogate model value evaluations
Show JSON schema
{ "title": "EfficientGlobalExportApproxPointsFile", "description": "Output file for surrogate model value evaluations", "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 }, "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" } ] } }, "$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, "required": [ "filename" ] }
- Fields:
- field filename: str [Required]
Output file for surrogate model value evaluations
- field format: MethodExportApproxFormatCustomAnnotated | MethodExportApproxFormatAnnotated | MethodExportApproxFormatFreeform [Optional]
Tabular Format
- pydantic model dakota.spec.method.efficient_global.EfficientGlobalImportBuildPointsFile
File containing points you wish to use to build a surrogate
Show JSON schema
{ "title": "EfficientGlobalImportBuildPointsFile", "description": "File containing points you wish to use to build a surrogate", "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 }, "filename": { "description": "File containing points you wish to use to build a surrogate", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "method.import_build_points_file", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "active_only": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Import only active variables from tabular data file", "title": "Active Only", "x-materialization": [ { "ir_key": "method.import_build_active_only", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$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, "required": [ "filename" ] }
- Fields:
- field active_only: Literal[True] | None = None
Import only active variables from tabular data file
- field filename: str [Required]
File containing points you wish to use to build a surrogate
- field format: MethodImportBuildFormatCustomAnnotated | MethodImportBuildFormatAnnotated | MethodImportBuildFormatFreeform [Optional]
Tabular Format
