surrogate_based_global
- pydantic model dakota.spec.method.surrogate_based_global.SurrogateBasedGlobalSelection
Generated model for SurrogateBasedGlobalSelection
Show JSON schema
{ "title": "SurrogateBasedGlobalSelection", "description": "Generated model for SurrogateBasedGlobalSelection", "type": "object", "properties": { "surrogate_based_global": { "$ref": "#/$defs/SurrogateBasedGlobalConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "SURROGATE_BASED_GLOBAL" } ] } }, "$defs": { "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" }, "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" }, "SurrogateBasedGlobalConfig": { "additionalProperties": false, "description": "Adaptive Global Surrogate-Based Optimization", "properties": { "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" } ] }, "sub_method": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/SurrogateBasedGlobalMethodPointer" }, { "$ref": "#/$defs/SurrogateBasedGlobalMethodName" } ], "description": "Sub-method Selection", "title": "Sub Method", "x-union-pattern": 4 }, "model_pointer": { "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "type": "string", "x-aliases": [ "approx_model_pointer" ], "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "replace_points": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "(Recommended) Replace points in the surrogate training set, instead of appending", "title": "Replace Points", "x-materialization": [ { "ir_key": "method.sbg.replace_points", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "sub_method", "model_pointer" ], "title": "SurrogateBasedGlobalConfig", "type": "object" }, "SurrogateBasedGlobalMethodName": { "additionalProperties": false, "description": "Specify sub-method by name", "properties": { "method_name": { "description": "Specify sub-method by name", "title": "Method Name", "type": "string", "x-aliases": [ "approx_method_name" ], "x-materialization": [ { "ir_key": "method.sub_method_name", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_name" ], "title": "SurrogateBasedGlobalMethodName", "type": "object" }, "SurrogateBasedGlobalMethodPointer": { "additionalProperties": false, "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem", "properties": { "method_pointer": { "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem", "title": "Method Pointer", "type": "string", "x-aliases": [ "approx_method_pointer" ], "x-block-pointer": "method", "x-materialization": [ { "ir_key": "method.sub_method_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_pointer" ], "title": "SurrogateBasedGlobalMethodPointer", "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": [ "surrogate_based_global" ] }
- Fields:
- field surrogate_based_global: SurrogateBasedGlobalConfig [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.surrogate_based_global.SurrogateBasedGlobalConfig
Adaptive Global Surrogate-Based Optimization
Show JSON schema
{ "title": "SurrogateBasedGlobalConfig", "description": "Adaptive Global Surrogate-Based Optimization", "type": "object", "properties": { "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" } ] }, "sub_method": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/SurrogateBasedGlobalMethodPointer" }, { "$ref": "#/$defs/SurrogateBasedGlobalMethodName" } ], "description": "Sub-method Selection", "title": "Sub Method", "x-union-pattern": 4 }, "model_pointer": { "description": "Identifier for model block to be used by a method", "title": "Model Pointer", "type": "string", "x-aliases": [ "approx_model_pointer" ], "x-block-pointer": "model", "x-materialization": [ { "ir_key": "method.model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "replace_points": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "(Recommended) Replace points in the surrogate training set, instead of appending", "title": "Replace Points", "x-materialization": [ { "ir_key": "method.sbg.replace_points", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "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" }, "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" }, "SurrogateBasedGlobalMethodName": { "additionalProperties": false, "description": "Specify sub-method by name", "properties": { "method_name": { "description": "Specify sub-method by name", "title": "Method Name", "type": "string", "x-aliases": [ "approx_method_name" ], "x-materialization": [ { "ir_key": "method.sub_method_name", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_name" ], "title": "SurrogateBasedGlobalMethodName", "type": "object" }, "SurrogateBasedGlobalMethodPointer": { "additionalProperties": false, "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem", "properties": { "method_pointer": { "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem", "title": "Method Pointer", "type": "string", "x-aliases": [ "approx_method_pointer" ], "x-block-pointer": "method", "x-materialization": [ { "ir_key": "method.sub_method_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_pointer" ], "title": "SurrogateBasedGlobalMethodPointer", "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": [ "sub_method", "model_pointer" ] }
- Fields:
- field final_solutions: int = 0
Number of designs returned as the best solutions
- Constraints:
ge = 0
- field id_method: str | None = None
Name the method block; helpful when there are multiple
- field max_iterations: int = 9223372036854775807
Number of iterations allowed for optimizers and adaptive UQ methods
- Constraints:
ge = 0
- field model_pointer: str [Required]
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 replace_points: Literal[True] | None = None
(Recommended) Replace points in the surrogate training set, instead of appending
- field sub_method: SurrogateBasedGlobalMethodPointer | SurrogateBasedGlobalMethodName [Required]
Sub-method Selection
Generated Pydantic models for method.surrogate_based_global
- pydantic model dakota.spec.method.surrogate_based_global.SurrogateBasedGlobalMethodName
Specify sub-method by name
Show JSON schema
{ "title": "SurrogateBasedGlobalMethodName", "description": "Specify sub-method by name", "type": "object", "properties": { "method_name": { "description": "Specify sub-method by name", "title": "Method Name", "type": "string", "x-aliases": [ "approx_method_name" ], "x-materialization": [ { "ir_key": "method.sub_method_name", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "method_name" ] }
- Fields:
- field method_name: str [Required]
Specify sub-method by name
- pydantic model dakota.spec.method.surrogate_based_global.SurrogateBasedGlobalMethodPointer
Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem
Show JSON schema
{ "title": "SurrogateBasedGlobalMethodPointer", "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem", "type": "object", "properties": { "method_pointer": { "description": "Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem", "title": "Method Pointer", "type": "string", "x-aliases": [ "approx_method_pointer" ], "x-block-pointer": "method", "x-materialization": [ { "ir_key": "method.sub_method_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "method_pointer" ] }
- Fields:
- field method_pointer: str [Required]
Pointer to sub-method to apply to a surrogate or branch-and-bound sub-problem
