snowpac
- pydantic model dakota.spec.method.snowpac.SnowpacSelection
Generated model for SnowpacSelection
Show JSON schema
{ "title": "SnowpacSelection", "description": "Generated model for SnowpacSelection", "type": "object", "properties": { "snowpac": { "$ref": "#/$defs/SnowpacConfig", "x-materialization": [ { "ir_key": "method.algorithm", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "MIT_SNOWPAC" } ] } }, "$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" }, "DefaultTrustRegionContext2TrustRegion": { "additionalProperties": false, "description": "Use trust region as the globalization strategy.", "properties": { "initial_size": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Trust region initial size (relative to bounds)", "title": "Initial Size", "x-materialization": [ { "ir_key": "method.trust_region.initial_size", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "minimum_size": { "default": 1e-06, "description": "Trust region minimum size", "title": "Minimum Size", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.minimum_size", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "contract_threshold": { "default": 0.25, "description": "Shrink trust region if trust region ratio is below this value", "title": "Contract Threshold", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.contract_threshold", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "expand_threshold": { "default": 0.75, "description": "Expand trust region if trust region ratio is above this value", "title": "Expand Threshold", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.expand_threshold", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "contraction_factor": { "default": 0.25, "description": "Amount by which step length is rescaled", "title": "Contraction Factor", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.contraction_factor", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "expansion_factor": { "default": 2.0, "description": "Trust region expansion factor", "title": "Expansion Factor", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.expansion_factor", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "title": "DefaultTrustRegionContext2TrustRegion", "type": "object", "x-model-validations": [ { "validationContext": "trust_region", "validationErrorMessage": "For trust_region, trust region parameters are invalid.", "validationFields": [ "initial_size", "minimum_size", "contract_threshold", "expand_threshold", "contraction_factor", "expansion_factor" ], "validationLiterals": [], "validationRuleName": "trust_region_validate" } ] }, "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" }, "SnowpacConfig": { "additionalProperties": false, "description": "Stochastic version of NOWPAC that incorporates error estimates and noise mitigation.", "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" } ] }, "scaling": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Turn on scaling for variables, responses, and constraints", "title": "Scaling", "x-materialization": [ { "ir_key": "method.scaling", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "max_function_evaluations": { "default": 9223372036854775807, "description": "Number of function evaluations allowed for optimizers", "minimum": 0, "title": "Max Function Evaluations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_function_evaluations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "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" } ] }, "trust_region": { "anyOf": [ { "$ref": "#/$defs/DefaultTrustRegionContext2TrustRegion" }, { "type": "null" } ], "default": null, "description": "Use trust region as the globalization strategy." }, "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" } ] }, "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" } ] } }, "title": "SnowpacConfig", "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": [ "snowpac" ] }
- field snowpac: SnowpacConfig [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.snowpac.SnowpacConfig
Stochastic version of NOWPAC that incorporates error estimates and noise mitigation.
Show JSON schema
{ "title": "SnowpacConfig", "description": "Stochastic version of NOWPAC that incorporates error estimates and noise mitigation.", "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" } ] }, "scaling": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Turn on scaling for variables, responses, and constraints", "title": "Scaling", "x-materialization": [ { "ir_key": "method.scaling", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "max_function_evaluations": { "default": 9223372036854775807, "description": "Number of function evaluations allowed for optimizers", "minimum": 0, "title": "Max Function Evaluations", "type": "integer", "x-materialization": [ { "ir_key": "method.max_function_evaluations", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "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" } ] }, "trust_region": { "anyOf": [ { "$ref": "#/$defs/DefaultTrustRegionContext2TrustRegion" }, { "type": "null" } ], "default": null, "description": "Use trust region as the globalization strategy." }, "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" } ] }, "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" } ] } }, "$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" }, "DefaultTrustRegionContext2TrustRegion": { "additionalProperties": false, "description": "Use trust region as the globalization strategy.", "properties": { "initial_size": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Trust region initial size (relative to bounds)", "title": "Initial Size", "x-materialization": [ { "ir_key": "method.trust_region.initial_size", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "minimum_size": { "default": 1e-06, "description": "Trust region minimum size", "title": "Minimum Size", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.minimum_size", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "contract_threshold": { "default": 0.25, "description": "Shrink trust region if trust region ratio is below this value", "title": "Contract Threshold", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.contract_threshold", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "expand_threshold": { "default": 0.75, "description": "Expand trust region if trust region ratio is above this value", "title": "Expand Threshold", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.expand_threshold", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "contraction_factor": { "default": 0.25, "description": "Amount by which step length is rescaled", "title": "Contraction Factor", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.contraction_factor", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] }, "expansion_factor": { "default": 2.0, "description": "Trust region expansion factor", "title": "Expansion Factor", "type": "number", "x-materialization": [ { "ir_key": "method.trust_region.expansion_factor", "ir_value_type": "Real", "storage_type": "DIRECT_VALUE" } ] } }, "title": "DefaultTrustRegionContext2TrustRegion", "type": "object", "x-model-validations": [ { "validationContext": "trust_region", "validationErrorMessage": "For trust_region, trust region parameters are invalid.", "validationFields": [ "initial_size", "minimum_size", "contract_threshold", "expand_threshold", "contraction_factor", "expansion_factor" ], "validationLiterals": [], "validationRuleName": "trust_region_validate" } ] }, "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 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_function_evaluations: int = 9223372036854775807
Number of function evaluations allowed for optimizers
- Constraints:
ge = 0
- 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 scaling: Literal[True] | None = None
Turn on scaling for variables, responses, and constraints
- field seed: int | None = None
Seed of the random number generator
- Constraints:
gt = 0
- field trust_region: DefaultTrustRegionContext2TrustRegion | None = None
Use trust region as the globalization strategy.
Generated Pydantic models for method.snowpac
