multi_start
- pydantic model dakota.spec.method.multi_start.MultiStartSelection
Generated model for MultiStartSelection
Show JSON schema
{ "title": "MultiStartSelection", "description": "Generated model for MultiStartSelection", "type": "object", "properties": { "multi_start": { "$ref": "#/$defs/MultiStartConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "MULTI_START" } ] } }, "$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" }, "MethodIteratorServerSchedulingDedicated": { "additionalProperties": false, "description": "Specify a dedicated scheduler partition for concurrent iterator executions", "properties": { "dedicated": { "const": true, "default": true, "description": "Specify a dedicated scheduler partition for concurrent iterator executions", "title": "Dedicated", "type": "boolean", "x-materialization": [ { "ir_key": "method.iterator_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEDICATED_SCHEDULER_DYNAMIC" } ] } }, "title": "MethodIteratorServerSchedulingDedicated", "type": "object" }, "MethodIteratorServerSchedulingPeer": { "additionalProperties": false, "description": "Specify a peer partition for parallel iterator scheduling", "properties": { "peer": { "const": true, "default": true, "description": "Specify a peer partition for parallel iterator scheduling", "title": "Peer", "type": "boolean", "x-materialization": [ { "ir_key": "method.iterator_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_SCHEDULING" } ] } }, "title": "MethodIteratorServerSchedulingPeer", "type": "object" }, "MultiStartConfig": { "additionalProperties": false, "description": "Multi-Start Optimization Method", "properties": { "iterator_servers": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of iterator servers when Dakota is run in parallel", "title": "Iterator Servers", "x-materialization": [ { "ir_key": "method.iterator_servers", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "iterator_scheduling": { "anyOf": [ { "$ref": "#/$defs/MethodIteratorServerSchedulingDedicated" }, { "$ref": "#/$defs/MethodIteratorServerSchedulingPeer" }, { "type": "null" } ], "default": null, "description": "Specify the scheduling of concurrent iterators when Dakota is run in parallel", "title": "Iterator Scheduling", "x-union-pattern": 2 }, "processors_per_iterator": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of processors per iterator server when Dakota is run in parallel", "title": "Processors Per Iterator", "x-materialization": [ { "ir_key": "method.processors_per_iterator", "ir_value_type": "int", "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/MultiStartMethodName" }, { "$ref": "#/$defs/MultiStartMethodPointer" } ], "description": "Sub-method Selection", "title": "Sub Method", "x-union-pattern": 4 }, "random_starts": { "anyOf": [ { "$ref": "#/$defs/RandomStarts" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of random starting points" }, "starting_points": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of user-specified starting points", "title": "Starting Points", "x-materialization": [ { "ir_key": "method.concurrent.parameter_sets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "sub_method" ], "title": "MultiStartConfig", "type": "object" }, "MultiStartMethodName": { "additionalProperties": false, "description": "Specify sub-method by name", "properties": { "method_name": { "$ref": "#/$defs/MultiStartMethodNameConfig", "argument": "method_name" } }, "required": [ "method_name" ], "title": "MultiStartMethodName", "type": "object" }, "MultiStartMethodNameConfig": { "additionalProperties": false, "description": "Specify sub-method by name", "properties": { "method_name": { "description": "Specify sub-method by name", "title": "Method Name", "type": "string", "x-materialization": [ { "ir_key": "method.sub_method_name", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "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.sub_model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_name" ], "title": "MultiStartMethodNameConfig", "type": "object" }, "MultiStartMethodPointer": { "additionalProperties": false, "description": "Pointer to sub-method to run from each starting point", "properties": { "method_pointer": { "description": "Pointer to sub-method to run from each starting point", "title": "Method Pointer", "type": "string", "x-block-pointer": "method", "x-materialization": [ { "ir_key": "method.sub_method_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_pointer" ], "title": "MultiStartMethodPointer", "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" }, "RandomStarts": { "additionalProperties": false, "description": "Number of random starting points", "properties": { "count": { "default": 0, "description": "Number of random starting points", "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "method.concurrent.random_jobs", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "seed": { "anyOf": [ { "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" } ] } }, "title": "RandomStarts", "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": [ "multi_start" ] }
- field multi_start: MultiStartConfig [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.multi_start.MultiStartConfig
Multi-Start Optimization Method
Show JSON schema
{ "title": "MultiStartConfig", "description": "Multi-Start Optimization Method", "type": "object", "properties": { "iterator_servers": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of iterator servers when Dakota is run in parallel", "title": "Iterator Servers", "x-materialization": [ { "ir_key": "method.iterator_servers", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "iterator_scheduling": { "anyOf": [ { "$ref": "#/$defs/MethodIteratorServerSchedulingDedicated" }, { "$ref": "#/$defs/MethodIteratorServerSchedulingPeer" }, { "type": "null" } ], "default": null, "description": "Specify the scheduling of concurrent iterators when Dakota is run in parallel", "title": "Iterator Scheduling", "x-union-pattern": 2 }, "processors_per_iterator": { "anyOf": [ { "exclusiveMinimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Specify the number of processors per iterator server when Dakota is run in parallel", "title": "Processors Per Iterator", "x-materialization": [ { "ir_key": "method.processors_per_iterator", "ir_value_type": "int", "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/MultiStartMethodName" }, { "$ref": "#/$defs/MultiStartMethodPointer" } ], "description": "Sub-method Selection", "title": "Sub Method", "x-union-pattern": 4 }, "random_starts": { "anyOf": [ { "$ref": "#/$defs/RandomStarts" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of random starting points" }, "starting_points": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "List of user-specified starting points", "title": "Starting Points", "x-materialization": [ { "ir_key": "method.concurrent.parameter_sets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "$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" }, "MethodIteratorServerSchedulingDedicated": { "additionalProperties": false, "description": "Specify a dedicated scheduler partition for concurrent iterator executions", "properties": { "dedicated": { "const": true, "default": true, "description": "Specify a dedicated scheduler partition for concurrent iterator executions", "title": "Dedicated", "type": "boolean", "x-materialization": [ { "ir_key": "method.iterator_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "DEDICATED_SCHEDULER_DYNAMIC" } ] } }, "title": "MethodIteratorServerSchedulingDedicated", "type": "object" }, "MethodIteratorServerSchedulingPeer": { "additionalProperties": false, "description": "Specify a peer partition for parallel iterator scheduling", "properties": { "peer": { "const": true, "default": true, "description": "Specify a peer partition for parallel iterator scheduling", "title": "Peer", "type": "boolean", "x-materialization": [ { "ir_key": "method.iterator_scheduling", "ir_value_type": "short", "storage_type": "PRESENCE_ENUM", "stored_value": "PEER_SCHEDULING" } ] } }, "title": "MethodIteratorServerSchedulingPeer", "type": "object" }, "MultiStartMethodName": { "additionalProperties": false, "description": "Specify sub-method by name", "properties": { "method_name": { "$ref": "#/$defs/MultiStartMethodNameConfig", "argument": "method_name" } }, "required": [ "method_name" ], "title": "MultiStartMethodName", "type": "object" }, "MultiStartMethodNameConfig": { "additionalProperties": false, "description": "Specify sub-method by name", "properties": { "method_name": { "description": "Specify sub-method by name", "title": "Method Name", "type": "string", "x-materialization": [ { "ir_key": "method.sub_method_name", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "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.sub_model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_name" ], "title": "MultiStartMethodNameConfig", "type": "object" }, "MultiStartMethodPointer": { "additionalProperties": false, "description": "Pointer to sub-method to run from each starting point", "properties": { "method_pointer": { "description": "Pointer to sub-method to run from each starting point", "title": "Method Pointer", "type": "string", "x-block-pointer": "method", "x-materialization": [ { "ir_key": "method.sub_method_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_pointer" ], "title": "MultiStartMethodPointer", "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" }, "RandomStarts": { "additionalProperties": false, "description": "Number of random starting points", "properties": { "count": { "default": 0, "description": "Number of random starting points", "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "method.concurrent.random_jobs", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "seed": { "anyOf": [ { "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" } ] } }, "title": "RandomStarts", "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": [ "sub_method" ] }
- 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 iterator_scheduling: MethodIteratorServerSchedulingDedicated | MethodIteratorServerSchedulingPeer | None = None
Specify the scheduling of concurrent iterators when Dakota is run in parallel
- field iterator_servers: int | None = None
Specify the number of iterator servers when Dakota is run in parallel
- Constraints:
gt = 0
- field output: Debug | Verbose | Normal | Quiet | Silent [Optional]
Control how much method information is written to the screen and output file
- field processors_per_iterator: int | None = None
Specify the number of processors per iterator server when Dakota is run in parallel
- Constraints:
gt = 0
- field random_starts: RandomStarts | None = None
Number of random starting points
- field starting_points: list[DakotaFloat] | None = None
List of user-specified starting points
- field sub_method: MultiStartMethodName | MultiStartMethodPointer [Required]
Sub-method Selection
Generated Pydantic models for method.multi_start
- pydantic model dakota.spec.method.multi_start.MultiStartMethodName
Specify sub-method by name
Show JSON schema
{ "title": "MultiStartMethodName", "description": "Specify sub-method by name", "type": "object", "properties": { "method_name": { "$ref": "#/$defs/MultiStartMethodNameConfig", "argument": "method_name" } }, "$defs": { "MultiStartMethodNameConfig": { "additionalProperties": false, "description": "Specify sub-method by name", "properties": { "method_name": { "description": "Specify sub-method by name", "title": "Method Name", "type": "string", "x-materialization": [ { "ir_key": "method.sub_method_name", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "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.sub_model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "method_name" ], "title": "MultiStartMethodNameConfig", "type": "object" } }, "additionalProperties": false, "required": [ "method_name" ] }
- field method_name: MultiStartMethodNameConfig [Required]
Specify sub-method by name
- pydantic model dakota.spec.method.multi_start.MultiStartMethodNameConfig
Specify sub-method by name
Show JSON schema
{ "title": "MultiStartMethodNameConfig", "description": "Specify sub-method by name", "type": "object", "properties": { "method_name": { "description": "Specify sub-method by name", "title": "Method Name", "type": "string", "x-materialization": [ { "ir_key": "method.sub_method_name", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "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.sub_model_pointer", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "method_name" ] }
- field method_name: str [Required]
Specify sub-method by name
- field model_pointer: str | None = None
Identifier for model block to be used by a method
- pydantic model dakota.spec.method.multi_start.MultiStartMethodPointer
Pointer to sub-method to run from each starting point
Show JSON schema
{ "title": "MultiStartMethodPointer", "description": "Pointer to sub-method to run from each starting point", "type": "object", "properties": { "method_pointer": { "description": "Pointer to sub-method to run from each starting point", "title": "Method Pointer", "type": "string", "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 run from each starting point
- pydantic model dakota.spec.method.multi_start.RandomStarts
Number of random starting points
Show JSON schema
{ "title": "RandomStarts", "description": "Number of random starting points", "type": "object", "properties": { "count": { "default": 0, "description": "Number of random starting points", "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "method.concurrent.random_jobs", "ir_value_type": "int", "storage_type": "DIRECT_VALUE" } ] }, "seed": { "anyOf": [ { "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" } ] } }, "additionalProperties": false }
- Fields:
- field count: int = 0
Number of random starting points
- field seed: int | None = None
Seed of the random number generator
