hybrid_sequential

pydantic model dakota.spec.method.hybrid_sequential.HybridSequentialSelection

Methods are run one at a time, in sequence

Show JSON schema
{
   "title": "HybridSequentialSelection",
   "description": "Methods are run one at a time, in sequence",
   "type": "object",
   "properties": {
      "hybrid_sequential": {
         "$ref": "#/$defs/HybridSequentialConfig",
         "x-aliases": [
            "hybrid_uncoupled"
         ],
         "x-group": "Optimization: Other",
         "x-materialization": [
            {
               "ir_key": "method.algorithm",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "HYBRID"
            },
            {
               "ir_key": "method.sub_method",
               "ir_value_type": "unsigned short",
               "storage_type": "PRESENCE_ENUM",
               "stored_value": "SUBMETHOD_SEQUENTIAL"
            }
         ]
      }
   },
   "$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"
      },
      "HybridSequentialConfig": {
         "additionalProperties": false,
         "description": "Methods are run one at a time, in sequence",
         "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"
                  }
               ]
            },
            "sub_method": {
               "anchor": true,
               "anyOf": [
                  {
                     "$ref": "#/$defs/SequentialMethodNameList"
                  },
                  {
                     "$ref": "#/$defs/SequentialMethodPointerList"
                  }
               ],
               "description": "Sub-method Selection",
               "title": "Sub Method",
               "x-pointer-union": true,
               "x-union-pattern": 4
            },
            "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"
                  }
               ],
               "x-taglist": "method"
            },
            "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"
                  }
               ]
            }
         },
         "required": [
            "sub_method"
         ],
         "title": "HybridSequentialConfig",
         "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"
      },
      "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"
      },
      "SequentialMethodNameList": {
         "additionalProperties": false,
         "description": "List of Dakota methods to sequentially run",
         "properties": {
            "method_name_list": {
               "$ref": "#/$defs/SequentialMethodNameListConfig",
               "argument": "method_name_list"
            }
         },
         "required": [
            "method_name_list"
         ],
         "title": "SequentialMethodNameList",
         "type": "object"
      },
      "SequentialMethodNameListConfig": {
         "additionalProperties": false,
         "description": "List of Dakota methods to sequentially run",
         "properties": {
            "method_name_list": {
               "description": "List of Dakota methods to sequentially run",
               "items": {
                  "type": "string"
               },
               "title": "Method Name List",
               "type": "array",
               "x-materialization": [
                  {
                     "ir_key": "method.hybrid.method_names",
                     "ir_value_type": "StringArray",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "model_pointer_list": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Associate models with method names",
               "title": "Model Pointer List",
               "x-materialization": [
                  {
                     "ir_key": "method.hybrid.model_pointers",
                     "ir_value_type": "StringArray",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "method_name_list"
         ],
         "title": "SequentialMethodNameListConfig",
         "type": "object"
      },
      "SequentialMethodPointerList": {
         "additionalProperties": false,
         "description": "Pointers to methods to execute sequentially",
         "properties": {
            "method_pointer_list": {
               "description": "Pointers to methods to execute sequentially",
               "items": {
                  "type": "string"
               },
               "title": "Method Pointer List",
               "type": "array",
               "x-block-pointer": "method",
               "x-materialization": [
                  {
                     "ir_key": "method.hybrid.method_pointers",
                     "ir_value_type": "StringArray",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "method_pointer_list"
         ],
         "title": "SequentialMethodPointerList",
         "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": [
      "hybrid_sequential"
   ]
}

Fields:
field hybrid_sequential: HybridSequentialConfig [Required]

Methods are run one at a time, in sequence

pydantic model dakota.spec.method.hybrid_sequential.HybridSequentialConfig

Methods are run one at a time, in sequence

Show JSON schema
{
   "title": "HybridSequentialConfig",
   "description": "Methods are run one at a time, in sequence",
   "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"
            }
         ]
      },
      "sub_method": {
         "anchor": true,
         "anyOf": [
            {
               "$ref": "#/$defs/SequentialMethodNameList"
            },
            {
               "$ref": "#/$defs/SequentialMethodPointerList"
            }
         ],
         "description": "Sub-method Selection",
         "title": "Sub Method",
         "x-pointer-union": true,
         "x-union-pattern": 4
      },
      "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"
            }
         ],
         "x-taglist": "method"
      },
      "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"
            }
         ]
      }
   },
   "$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"
      },
      "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"
      },
      "SequentialMethodNameList": {
         "additionalProperties": false,
         "description": "List of Dakota methods to sequentially run",
         "properties": {
            "method_name_list": {
               "$ref": "#/$defs/SequentialMethodNameListConfig",
               "argument": "method_name_list"
            }
         },
         "required": [
            "method_name_list"
         ],
         "title": "SequentialMethodNameList",
         "type": "object"
      },
      "SequentialMethodNameListConfig": {
         "additionalProperties": false,
         "description": "List of Dakota methods to sequentially run",
         "properties": {
            "method_name_list": {
               "description": "List of Dakota methods to sequentially run",
               "items": {
                  "type": "string"
               },
               "title": "Method Name List",
               "type": "array",
               "x-materialization": [
                  {
                     "ir_key": "method.hybrid.method_names",
                     "ir_value_type": "StringArray",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            },
            "model_pointer_list": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Associate models with method names",
               "title": "Model Pointer List",
               "x-materialization": [
                  {
                     "ir_key": "method.hybrid.model_pointers",
                     "ir_value_type": "StringArray",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "method_name_list"
         ],
         "title": "SequentialMethodNameListConfig",
         "type": "object"
      },
      "SequentialMethodPointerList": {
         "additionalProperties": false,
         "description": "Pointers to methods to execute sequentially",
         "properties": {
            "method_pointer_list": {
               "description": "Pointers to methods to execute sequentially",
               "items": {
                  "type": "string"
               },
               "title": "Method Pointer List",
               "type": "array",
               "x-block-pointer": "method",
               "x-materialization": [
                  {
                     "ir_key": "method.hybrid.method_pointers",
                     "ir_value_type": "StringArray",
                     "storage_type": "DIRECT_VALUE"
                  }
               ]
            }
         },
         "required": [
            "method_pointer_list"
         ],
         "title": "SequentialMethodPointerList",
         "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"
   ]
}

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 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 sub_method: SequentialMethodNameList | SequentialMethodPointerList [Required]

Sub-method Selection

Pydantic models for the hybrid_sequential method.

class dakota.spec.method.hybrid_sequential.SequentialMethodNameListConfig(*, method_name_list: list[str], model_pointer_list: list[str] | None = None)

List of Dakota methods to sequentially run

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.method.hybrid_sequential.SequentialMethodPointerList(*, method_pointer_list: list[str])

Pointers to methods to execute sequentially

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.method.hybrid_sequential.SequentialMethodNameList(*, method_name_list: SequentialMethodNameListConfig)

List of Dakota methods to sequentially run

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models

class dakota.spec.method.hybrid_sequential.SequentialConfig(*, iterator_servers: Annotated[int | None, Gt(gt=0)] = None, iterator_scheduling: MethodIteratorServerSchedulingDedicated | MethodIteratorServerSchedulingPeer | None = None, processors_per_iterator: Annotated[int | None, Gt(gt=0)] = None, sub_method: SequentialMethodNameList | SequentialMethodPointerList)

Methods are run one at a time, in sequence

model_config = {'extra': 'forbid', 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

universal_validator()

Example universal validator that runs for all models