Responses
- pydantic model dakota.spec.responses.ResponsesConfig
Description of the model output data returned to Dakota upon evaluation of an interface.
Show JSON schema
{ "title": "ResponsesConfig", "description": "Description of the model output data returned to Dakota upon evaluation of an interface.", "type": "object", "properties": { "hessian_type": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/NoHessians" }, { "$ref": "#/$defs/NumericalHessians" }, { "$ref": "#/$defs/QuasiHessians" }, { "$ref": "#/$defs/AnalyticHessians" }, { "$ref": "#/$defs/MixedHessians" } ], "description": "Hessian Type", "title": "Hessian Type", "x-union-pattern": 4 }, "gradient_type": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/NoGradients" }, { "$ref": "#/$defs/AnalyticGradients" }, { "$ref": "#/$defs/MixedGradients" }, { "$ref": "#/$defs/NumericalGradients" } ], "description": "Gradient Type", "title": "Gradient Type", "x-union-pattern": 4 }, "id_responses": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name the responses block; helpful when there are multiple", "title": "Id Responses", "x-materialization": [ { "ir_key": "responses.id", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "descriptors": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Labels for the responses", "title": "Descriptors", "x-aliases": [ "response_descriptors" ], "x-materialization": [ { "ir_key": "responses.labels", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "response_type": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ObjectiveFunctions" }, { "$ref": "#/$defs/CalibrationTerms" }, { "$ref": "#/$defs/ResponseFunctions" } ], "description": "Response Type", "title": "Response Type", "x-union-pattern": 4 }, "metadata": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "(Experimental) Labels for floating point response metadata", "title": "Metadata", "x-materialization": [ { "ir_key": "responses.metadata_labels", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "AnalyticGradients": { "additionalProperties": false, "description": "Analysis driver will return gradients", "properties": { "analytic_gradients": { "const": true, "default": true, "description": "Analysis driver will return gradients", "title": "Analytic Gradients", "type": "boolean", "x-materialization": [ { "ir_key": "responses.gradient_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "analytic" } ] } }, "title": "AnalyticGradients", "type": "object" }, "AnalyticHessians": { "additionalProperties": false, "description": "Hessians are needed and are available directly from the analysis driver", "properties": { "analytic_hessians": { "const": true, "default": true, "description": "Hessians are needed and are available directly from the analysis driver", "title": "Analytic Hessians", "type": "boolean", "x-materialization": [ { "ir_key": "responses.hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "analytic" } ] } }, "title": "AnalyticHessians", "type": "object" }, "CalibrationData": { "additionalProperties": false, "description": "Supply field or mixed field/scalar calibration data", "properties": { "calibration_data": { "$ref": "#/$defs/CalibrationDataConfig", "x-materialization": [ { "ir_key": "responses.calibration_data", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "calibration_data" ], "title": "CalibrationData", "type": "object" }, "CalibrationDataConfig": { "additionalProperties": false, "description": "Supply field or mixed field/scalar calibration data", "properties": { "data_directory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify a directory containing the calibration field data files used with the mixed case specification", "title": "Data Directory", "x-materialization": [ { "ir_key": "responses.data_directory", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scalar_data_file": { "anyOf": [ { "$ref": "#/$defs/ScalarDataFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "Specify a scalar data file to complement field data files (mixed case)" }, "interpolate": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Flag to indicate interpolation of simulation values.", "title": "Interpolate", "x-materialization": [ { "ir_key": "responses.interpolate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "CalibrationDataConfig", "type": "object" }, "CalibrationDataFile": { "additionalProperties": false, "description": "Supply scalar calibration data only", "properties": { "calibration_data_file": { "$ref": "#/$defs/CalibrationDataFileConfig", "argument": "filename", "x-aliases": [ "least_squares_data_file" ] } }, "required": [ "calibration_data_file" ], "title": "CalibrationDataFile", "type": "object" }, "CalibrationDataFileConfig": { "additionalProperties": false, "description": "Supply scalar calibration data only", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Supply scalar calibration data only", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "CalibrationDataFileConfig", "type": "object" }, "CalibrationTerms": { "additionalProperties": false, "description": "Response type suitable for calibration or least squares", "properties": { "calibration_terms": { "$ref": "#/$defs/CalibrationTermsConfig", "argument": "count", "x-aliases": [ "least_squares_terms", "num_least_squares_terms" ] } }, "required": [ "calibration_terms" ], "title": "CalibrationTerms", "type": "object" }, "CalibrationTermsConfig": { "additionalProperties": false, "description": "Response type suitable for calibration or least squares", "properties": { "count": { "description": "Response type suitable for calibration or least squares", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scalar_calibration_terms": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar calibration terms", "title": "Scalar Calibration Terms", "x-materialization": [ { "ir_key": "responses.num_scalar_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_calibration_terms": { "anyOf": [ { "$ref": "#/$defs/FieldCalibrationTerms" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field calibration terms" }, "primary_scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each calibration term", "title": "Primary Scales", "x-aliases": [ "calibration_term_scales", "least_squares_term_scales" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "weights": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify weights for each objective function", "title": "Weights", "x-aliases": [ "calibration_weights", "least_squares_weights" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_weights", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "data_specification": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/CalibrationData" }, { "$ref": "#/$defs/CalibrationDataFile" }, { "type": "null" } ], "default": null, "description": "Calibration Data", "title": "Data Specification", "x-union-pattern": 2 }, "simulation_variance": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Variance applied to simulation responses", "title": "Simulation Variance", "x-materialization": [ { "ir_key": "responses.simulation_variance", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "nonlinear_inequality_constraints": { "anyOf": [ { "$ref": "#/$defs/CalibrationTermsNonlinearInequalityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear inequality constraints", "x-aliases": [ "num_nonlinear_inequality_constraints" ] }, "nonlinear_equality_constraints": { "anyOf": [ { "$ref": "#/$defs/CalibrationTermsNonlinearEqualityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear equality constraints", "x-aliases": [ "num_nonlinear_equality_constraints" ] } }, "required": [ "count" ], "title": "CalibrationTermsConfig", "type": "object", "x-model-validations": [ { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of weights must equal count.", "validationFields": [ "weights", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of simulation_variance must equal 1 or count.", "validationFields": [ "simulation_variance", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of data_specification.calibration_data.experiment_variance_type must equal 1 or count.", "validationFields": [ "data_specification.calibration_data.experiment_variance_type", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of data_specification.calibration_data_file.experiment_variance_type must equal 1 or count.", "validationFields": [ "data_specification.calibration_data_file.experiment_variance_type", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" } ] }, "CalibrationTermsNonlinearEqualityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear equality constraints", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "CalibrationTermsNonlinearEqualityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "CalibrationTermsNonlinearInequalityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear inequality constraints", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "CalibrationTermsNonlinearInequalityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] }, "FieldCalibrationTerms": { "additionalProperties": false, "description": "Number of field calibration terms", "properties": { "count": { "description": "Number of field calibration terms", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldCalibrationTerms", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_field_calibration_terms", "validationErrorMessage": "For responses_calibration_terms_field_calibration_terms, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "FieldObjectives": { "additionalProperties": false, "description": "Number of field objective functions", "properties": { "count": { "description": "Number of field objective functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_objectives", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldObjectives", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_field_objectives", "validationErrorMessage": "For responses_objective_functions_field_objectives, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "FieldResponses": { "additionalProperties": false, "description": "Number of field responses functions", "properties": { "count": { "description": "Number of field responses functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_responses", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldResponses", "type": "object", "x-model-validations": [ { "validationContext": "responses_response_functions_field_responses", "validationErrorMessage": "For responses_response_functions_field_responses, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "IdNumericalHessians": { "additionalProperties": false, "description": "Identify which numerical-Hessian corresponds to which response", "properties": { "values": { "description": "Identify which numerical-Hessian corresponds to which response", "items": { "type": "integer" }, "title": "Values", "type": "array", "x-materialization": [ { "ir_key": "responses.hessians.mixed.id_numerical", "ir_value_type": "IntSet", "storage_type": "INT_SET" } ] }, "fd_step_size": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Step size used when computing gradients and Hessians", "title": "Fd Step Size", "x-aliases": [ "fd_hessian_step_size" ], "x-materialization": [ { "ir_key": "responses.fd_hessian_step_size", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "values" ], "title": "IdNumericalHessians", "type": "object" }, "IdQuasiHessians": { "additionalProperties": false, "description": "Identify which quasi-Hessian corresponds to which response", "properties": { "values": { "description": "Identify which quasi-Hessian corresponds to which response", "items": { "type": "integer" }, "title": "Values", "type": "array", "x-materialization": [ { "ir_key": "responses.hessians.mixed.id_quasi", "ir_value_type": "IntSet", "storage_type": "INT_SET" } ] }, "approximation": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/IdQuasiHessiansBfgs" }, { "$ref": "#/$defs/IdQuasiHessiansSr1" } ], "description": "Quasi-Hessian Approximation", "title": "Approximation", "x-union-pattern": 4 } }, "required": [ "values", "approximation" ], "title": "IdQuasiHessians", "type": "object" }, "IdQuasiHessiansBfgs": { "additionalProperties": false, "description": "Use BFGS method to compute quasi-hessians", "properties": { "bfgs": { "$ref": "#/$defs/IdQuasiHessiansBfgsConfig", "x-materialization": [ { "ir_key": "responses.quasi_hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "bfgs" } ] } }, "required": [ "bfgs" ], "title": "IdQuasiHessiansBfgs", "type": "object" }, "IdQuasiHessiansBfgsConfig": { "additionalProperties": false, "description": "Use BFGS method to compute quasi-hessians", "properties": { "damped": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Numerical safeguarding for BFGS updates", "title": "Damped", "x-materialization": [ { "ir_key": "responses.quasi_hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "damped_bfgs" } ] } }, "title": "IdQuasiHessiansBfgsConfig", "type": "object" }, "IdQuasiHessiansSr1": { "additionalProperties": false, "description": "Use the Symmetric Rank 1 update method to compute quasi-Hessians", "properties": { "sr1": { "const": true, "default": true, "description": "Use the Symmetric Rank 1 update method to compute quasi-Hessians", "title": "Sr1", "type": "boolean", "x-materialization": [ { "ir_key": "responses.quasi_hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "sr1" } ] } }, "title": "IdQuasiHessiansSr1", "type": "object" }, "MixedGradients": { "additionalProperties": false, "description": "Gradients are needed and will be obtained from a mix of numerical and analytic sources", "properties": { "mixed_gradients": { "$ref": "#/$defs/MixedGradientsConfig", "x-materialization": [ { "ir_key": "responses.gradient_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "mixed" } ] } }, "required": [ "mixed_gradients" ], "title": "MixedGradients", "type": "object" }, "MixedGradientsConfig": { "additionalProperties": false, "description": "Gradients are needed and will be obtained from a mix of numerical and analytic sources", "properties": { "id_numerical_gradients": { "description": "Identify which numerical gradient corresponds to which response", "items": { "type": "integer" }, "title": "Id Numerical Gradients", "type": "array", "x-materialization": [ { "ir_key": "responses.gradients.mixed.id_numerical", "ir_value_type": "IntSet", "storage_type": "INT_SET" } ] }, "id_analytic_gradients": { "description": "Identify which analytical gradient corresponds to which response", "items": { "type": "integer" }, "title": "Id Analytic Gradients", "type": "array", "x-materialization": [ { "ir_key": "responses.gradients.mixed.id_analytic", "ir_value_type": "IntSet", "storage_type": "INT_SET" } ] }, "method_source": { "anyOf": [ { "$ref": "#/$defs/MixedGradientsMethodSourceDakota" }, { "$ref": "#/$defs/MixedGradientsMethodSourceVendor" } ], "description": "Specify which finite difference routine is used", "title": "Method Source", "x-model-default": "MixedGradientsMethodSourceDakota", "x-union-pattern": 1 }, "interval_type": { "anyOf": [ { "$ref": "#/$defs/MixedGradientsIntervalTypeForward" }, { "$ref": "#/$defs/MixedGradientsIntervalTypeCentral" } ], "description": "Specify how to compute gradients and hessians", "title": "Interval Type", "x-model-default": "MixedGradientsIntervalTypeForward", "x-union-pattern": 1 }, "fd_step_size": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Step size used when computing gradients and Hessians", "title": "Fd Step Size", "x-aliases": [ "fd_gradient_step_size" ], "x-materialization": [ { "ir_key": "responses.fd_gradient_step_size", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "id_numerical_gradients", "id_analytic_gradients" ], "title": "MixedGradientsConfig", "type": "object" }, "MixedGradientsIntervalTypeCentral": { "additionalProperties": false, "description": "Use central differences", "properties": { "central": { "const": true, "default": true, "description": "Use central differences", "title": "Central", "type": "boolean", "x-materialization": [ { "ir_key": "responses.interval_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "central" } ] } }, "title": "MixedGradientsIntervalTypeCentral", "type": "object" }, "MixedGradientsIntervalTypeForward": { "additionalProperties": false, "description": "(Default) Use forward differences", "properties": { "forward": { "const": true, "default": true, "description": "(Default) Use forward differences", "title": "Forward", "type": "boolean", "x-materialization": [ { "ir_key": "responses.interval_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "forward" } ] } }, "title": "MixedGradientsIntervalTypeForward", "type": "object" }, "MixedGradientsMethodSourceDakota": { "additionalProperties": false, "description": "(Default) Use internal Dakota finite differences algorithm", "properties": { "dakota": { "$ref": "#/$defs/MixedGradientsMethodSourceDakotaConfig", "x-materialization": [ { "ir_key": "responses.method_source", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "dakota" } ], "x-model-default": "MixedGradientsMethodSourceDakotaConfig" } }, "title": "MixedGradientsMethodSourceDakota", "type": "object" }, "MixedGradientsMethodSourceDakotaAbsolute": { "additionalProperties": false, "description": "Do not scale step-size", "properties": { "absolute": { "const": true, "default": true, "description": "Do not scale step-size", "title": "Absolute", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_gradient_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "absolute" } ] } }, "title": "MixedGradientsMethodSourceDakotaAbsolute", "type": "object" }, "MixedGradientsMethodSourceDakotaBounds": { "additionalProperties": false, "description": "Scale step-size by the domain of the parameter", "properties": { "bounds": { "const": true, "default": true, "description": "Scale step-size by the domain of the parameter", "title": "Bounds", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_gradient_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "bounds" } ] } }, "title": "MixedGradientsMethodSourceDakotaBounds", "type": "object" }, "MixedGradientsMethodSourceDakotaConfig": { "additionalProperties": false, "description": "(Default) Use internal Dakota finite differences algorithm", "properties": { "ignore_bounds": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Do not respect bounds when computing gradients or Hessians", "title": "Ignore Bounds", "x-materialization": [ { "ir_key": "responses.ignore_bounds", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "step_scaling": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/MixedGradientsMethodSourceDakotaRelative" }, { "$ref": "#/$defs/MixedGradientsMethodSourceDakotaAbsolute" }, { "$ref": "#/$defs/MixedGradientsMethodSourceDakotaBounds" } ], "description": "Step Scaling", "title": "Step Scaling", "x-model-default": "MixedGradientsMethodSourceDakotaRelative", "x-union-pattern": 1 } }, "title": "MixedGradientsMethodSourceDakotaConfig", "type": "object" }, "MixedGradientsMethodSourceDakotaRelative": { "additionalProperties": false, "description": "(Default) Scale step size by the parameter value", "properties": { "relative": { "const": true, "default": true, "description": "(Default) Scale step size by the parameter value", "title": "Relative", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_gradient_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "relative" } ] } }, "title": "MixedGradientsMethodSourceDakotaRelative", "type": "object" }, "MixedGradientsMethodSourceVendor": { "additionalProperties": false, "description": "Use non-Dakota fd algorithm", "properties": { "vendor": { "const": true, "default": true, "description": "Use non-Dakota fd algorithm", "title": "Vendor", "type": "boolean", "x-materialization": [ { "ir_key": "responses.method_source", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "vendor" } ] } }, "title": "MixedGradientsMethodSourceVendor", "type": "object" }, "MixedHessians": { "additionalProperties": false, "description": "Hessians are needed and will be obtained from a mix of numerical, analytic, and \\\"quasi\\\" sources", "properties": { "mixed_hessians": { "$ref": "#/$defs/MixedHessiansConfig", "description": "Hessians are needed and will be obtained from a mix of numerical, analytic, and \"quasi\" sources", "x-materialization": [ { "ir_key": "responses.hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "mixed" } ] } }, "required": [ "mixed_hessians" ], "title": "MixedHessians", "type": "object" }, "MixedHessiansAbsolute": { "additionalProperties": false, "description": "Do not scale step-size", "properties": { "absolute": { "const": true, "default": true, "description": "Do not scale step-size", "title": "Absolute", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_hessian_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "absolute" } ] } }, "title": "MixedHessiansAbsolute", "type": "object" }, "MixedHessiansBounds": { "additionalProperties": false, "description": "Scale step-size by the domain of the parameter", "properties": { "bounds": { "const": true, "default": true, "description": "Scale step-size by the domain of the parameter", "title": "Bounds", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_hessian_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "bounds" } ] } }, "title": "MixedHessiansBounds", "type": "object" }, "MixedHessiansConfig": { "additionalProperties": false, "description": "Hessians are needed and will be obtained from a mix of numerical, analytic, and \\\"quasi\\\" sources", "properties": { "id_numerical_hessians": { "anyOf": [ { "$ref": "#/$defs/IdNumericalHessians" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Identify which numerical-Hessian corresponds to which response" }, "step_scaling": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/MixedHessiansRelative" }, { "$ref": "#/$defs/MixedHessiansAbsolute" }, { "$ref": "#/$defs/MixedHessiansBounds" } ], "description": "Step Scaling", "title": "Step Scaling", "x-model-default": "MixedHessiansRelative", "x-union-pattern": 1 }, "interval_type": { "anyOf": [ { "$ref": "#/$defs/MixedHessiansIntervalTypeForward" }, { "$ref": "#/$defs/MixedHessiansIntervalTypeCentral" } ], "description": "Specify how to compute gradients and hessians", "title": "Interval Type", "x-model-default": "MixedHessiansIntervalTypeForward", "x-union-pattern": 1 }, "id_quasi_hessians": { "anyOf": [ { "$ref": "#/$defs/IdQuasiHessians" }, { "type": "null" } ], "argument": "values", "default": null, "description": "Identify which quasi-Hessian corresponds to which response" }, "id_analytic_hessians": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Identify which analytical Hessian corresponds to which response", "title": "Id Analytic Hessians", "x-materialization": [ { "ir_key": "responses.hessians.mixed.id_analytic", "ir_value_type": "IntSet", "storage_type": "INT_SET" } ] } }, "title": "MixedHessiansConfig", "type": "object" }, "MixedHessiansIntervalTypeCentral": { "additionalProperties": false, "description": "Use central differences", "properties": { "central": { "const": true, "default": true, "description": "Use central differences", "title": "Central", "type": "boolean", "x-materialization": [ { "ir_key": "responses.central_hess", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "MixedHessiansIntervalTypeCentral", "type": "object" }, "MixedHessiansIntervalTypeForward": { "additionalProperties": false, "description": "(Default) Use forward differences", "properties": { "forward": { "const": true, "default": true, "description": "(Default) Use forward differences", "title": "Forward", "type": "boolean", "x-materialization": [ { "ir_key": "responses.central_hess", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] } }, "title": "MixedHessiansIntervalTypeForward", "type": "object" }, "MixedHessiansRelative": { "additionalProperties": false, "description": "(Default) Scale step size by the parameter value", "properties": { "relative": { "const": true, "default": true, "description": "(Default) Scale step size by the parameter value", "title": "Relative", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_hessian_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "relative" } ] } }, "title": "MixedHessiansRelative", "type": "object" }, "NoGradients": { "additionalProperties": false, "description": "Gradients will not be used", "properties": { "no_gradients": { "const": true, "default": true, "description": "Gradients will not be used", "title": "No Gradients", "type": "boolean", "x-materialization": [ { "ir_key": "responses.gradient_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "none" } ] } }, "title": "NoGradients", "type": "object" }, "NoHessians": { "additionalProperties": false, "description": "Hessians will not be used", "properties": { "no_hessians": { "const": true, "default": true, "description": "Hessians will not be used", "title": "No Hessians", "type": "boolean", "x-materialization": [ { "ir_key": "responses.hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "none" } ] } }, "title": "NoHessians", "type": "object" }, "NumericalGradients": { "additionalProperties": false, "description": "Gradients are needed and will be approximated by finite differences", "properties": { "numerical_gradients": { "$ref": "#/$defs/NumericalGradientsConfig", "x-materialization": [ { "ir_key": "responses.gradient_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "numerical" } ] } }, "required": [ "numerical_gradients" ], "title": "NumericalGradients", "type": "object" }, "NumericalGradientsConfig": { "additionalProperties": false, "description": "Gradients are needed and will be approximated by finite differences", "properties": { "method_source": { "anyOf": [ { "$ref": "#/$defs/NumericalGradientsMethodSourceDakota" }, { "$ref": "#/$defs/NumericalGradientsMethodSourceVendor" } ], "description": "Specify which finite difference routine is used", "title": "Method Source", "x-model-default": "NumericalGradientsMethodSourceDakota", "x-union-pattern": 1 }, "interval_type": { "anyOf": [ { "$ref": "#/$defs/NumericalGradientsIntervalTypeForward" }, { "$ref": "#/$defs/NumericalGradientsIntervalTypeCentral" } ], "description": "Specify how to compute gradients and hessians", "title": "Interval Type", "x-model-default": "NumericalGradientsIntervalTypeForward", "x-union-pattern": 1 }, "fd_step_size": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Step size used when computing gradients and Hessians", "title": "Fd Step Size", "x-aliases": [ "fd_gradient_step_size" ], "x-materialization": [ { "ir_key": "responses.fd_gradient_step_size", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "title": "NumericalGradientsConfig", "type": "object" }, "NumericalGradientsIntervalTypeCentral": { "additionalProperties": false, "description": "Use central differences", "properties": { "central": { "const": true, "default": true, "description": "Use central differences", "title": "Central", "type": "boolean", "x-materialization": [ { "ir_key": "responses.interval_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "central" } ] } }, "title": "NumericalGradientsIntervalTypeCentral", "type": "object" }, "NumericalGradientsIntervalTypeForward": { "additionalProperties": false, "description": "(Default) Use forward differences", "properties": { "forward": { "const": true, "default": true, "description": "(Default) Use forward differences", "title": "Forward", "type": "boolean", "x-materialization": [ { "ir_key": "responses.interval_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "forward" } ] } }, "title": "NumericalGradientsIntervalTypeForward", "type": "object" }, "NumericalGradientsMethodSourceDakota": { "additionalProperties": false, "description": "(Default) Use internal Dakota finite differences algorithm", "properties": { "dakota": { "$ref": "#/$defs/NumericalGradientsMethodSourceDakotaConfig", "x-materialization": [ { "ir_key": "responses.method_source", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "dakota" } ], "x-model-default": "NumericalGradientsMethodSourceDakotaConfig" } }, "title": "NumericalGradientsMethodSourceDakota", "type": "object" }, "NumericalGradientsMethodSourceDakotaAbsolute": { "additionalProperties": false, "description": "Do not scale step-size", "properties": { "absolute": { "const": true, "default": true, "description": "Do not scale step-size", "title": "Absolute", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_gradient_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "absolute" } ] } }, "title": "NumericalGradientsMethodSourceDakotaAbsolute", "type": "object" }, "NumericalGradientsMethodSourceDakotaBounds": { "additionalProperties": false, "description": "Scale step-size by the domain of the parameter", "properties": { "bounds": { "const": true, "default": true, "description": "Scale step-size by the domain of the parameter", "title": "Bounds", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_gradient_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "bounds" } ] } }, "title": "NumericalGradientsMethodSourceDakotaBounds", "type": "object" }, "NumericalGradientsMethodSourceDakotaConfig": { "additionalProperties": false, "description": "(Default) Use internal Dakota finite differences algorithm", "properties": { "ignore_bounds": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Do not respect bounds when computing gradients or Hessians", "title": "Ignore Bounds", "x-materialization": [ { "ir_key": "responses.ignore_bounds", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] }, "step_scaling": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/NumericalGradientsMethodSourceDakotaRelative" }, { "$ref": "#/$defs/NumericalGradientsMethodSourceDakotaAbsolute" }, { "$ref": "#/$defs/NumericalGradientsMethodSourceDakotaBounds" } ], "description": "Step Scaling", "title": "Step Scaling", "x-model-default": "NumericalGradientsMethodSourceDakotaRelative", "x-union-pattern": 1 } }, "title": "NumericalGradientsMethodSourceDakotaConfig", "type": "object" }, "NumericalGradientsMethodSourceDakotaRelative": { "additionalProperties": false, "description": "(Default) Scale step size by the parameter value", "properties": { "relative": { "const": true, "default": true, "description": "(Default) Scale step size by the parameter value", "title": "Relative", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_gradient_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "relative" } ] } }, "title": "NumericalGradientsMethodSourceDakotaRelative", "type": "object" }, "NumericalGradientsMethodSourceVendor": { "additionalProperties": false, "description": "Use non-Dakota fd algorithm", "properties": { "vendor": { "const": true, "default": true, "description": "Use non-Dakota fd algorithm", "title": "Vendor", "type": "boolean", "x-materialization": [ { "ir_key": "responses.method_source", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "vendor" } ] } }, "title": "NumericalGradientsMethodSourceVendor", "type": "object" }, "NumericalHessians": { "additionalProperties": false, "description": "Hessians are needed and will be approximated by finite differences", "properties": { "numerical_hessians": { "$ref": "#/$defs/NumericalHessiansConfig", "x-materialization": [ { "ir_key": "responses.hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "numerical" } ] } }, "required": [ "numerical_hessians" ], "title": "NumericalHessians", "type": "object" }, "NumericalHessiansAbsolute": { "additionalProperties": false, "description": "Do not scale step-size", "properties": { "absolute": { "const": true, "default": true, "description": "Do not scale step-size", "title": "Absolute", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_hessian_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "absolute" } ] } }, "title": "NumericalHessiansAbsolute", "type": "object" }, "NumericalHessiansBounds": { "additionalProperties": false, "description": "Scale step-size by the domain of the parameter", "properties": { "bounds": { "const": true, "default": true, "description": "Scale step-size by the domain of the parameter", "title": "Bounds", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_hessian_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "bounds" } ] } }, "title": "NumericalHessiansBounds", "type": "object" }, "NumericalHessiansConfig": { "additionalProperties": false, "description": "Hessians are needed and will be approximated by finite differences", "properties": { "fd_step_size": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Step size used when computing gradients and Hessians", "title": "Fd Step Size", "x-aliases": [ "fd_hessian_step_size" ], "x-materialization": [ { "ir_key": "responses.fd_hessian_step_size", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "step_scaling": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/NumericalHessiansRelative" }, { "$ref": "#/$defs/NumericalHessiansAbsolute" }, { "$ref": "#/$defs/NumericalHessiansBounds" } ], "description": "Step Scaling", "title": "Step Scaling", "x-model-default": "NumericalHessiansRelative", "x-union-pattern": 1 }, "interval_type": { "anyOf": [ { "$ref": "#/$defs/NumericalHessiansIntervalTypeForward" }, { "$ref": "#/$defs/NumericalHessiansIntervalTypeCentral" } ], "description": "Specify how to compute gradients and hessians", "title": "Interval Type", "x-model-default": "NumericalHessiansIntervalTypeForward", "x-union-pattern": 1 } }, "title": "NumericalHessiansConfig", "type": "object" }, "NumericalHessiansIntervalTypeCentral": { "additionalProperties": false, "description": "Use central differences", "properties": { "central": { "const": true, "default": true, "description": "Use central differences", "title": "Central", "type": "boolean", "x-materialization": [ { "ir_key": "responses.central_hess", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "NumericalHessiansIntervalTypeCentral", "type": "object" }, "NumericalHessiansIntervalTypeForward": { "additionalProperties": false, "description": "(Default) Use forward differences", "properties": { "forward": { "const": true, "default": true, "description": "(Default) Use forward differences", "title": "Forward", "type": "boolean", "x-materialization": [ { "ir_key": "responses.central_hess", "ir_value_type": "bool", "storage_type": "PRESENCE_FALSE" } ] } }, "title": "NumericalHessiansIntervalTypeForward", "type": "object" }, "NumericalHessiansRelative": { "additionalProperties": false, "description": "(Default) Scale step size by the parameter value", "properties": { "relative": { "const": true, "default": true, "description": "(Default) Scale step size by the parameter value", "title": "Relative", "type": "boolean", "x-materialization": [ { "ir_key": "responses.fd_hessian_step_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "relative" } ] } }, "title": "NumericalHessiansRelative", "type": "object" }, "ObjectiveFunctions": { "additionalProperties": false, "description": "Response type suitable for optimization", "properties": { "objective_functions": { "$ref": "#/$defs/ObjectiveFunctionsConfig", "argument": "count", "x-aliases": [ "num_objective_functions" ] } }, "required": [ "objective_functions" ], "title": "ObjectiveFunctions", "type": "object", "x-model-validations": [ { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scale_types must be one of ['value', 'log', 'none'].", "validationFields": [ "primary_scale_types" ], "validationLiterals": [ "value", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scales must be provided when primary_scale_types includes 'value'.", "validationFields": [ "primary_scale_types", "primary_scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "ObjectiveFunctionsConfig": { "additionalProperties": false, "description": "Response type suitable for optimization", "properties": { "count": { "description": "Response type suitable for optimization", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_objective_functions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "sense": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Whether to minimize or maximize each objective function", "title": "Sense", "x-materialization": [ { "ir_key": "responses.primary_response_fn_sense", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "primary_scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each objective function", "title": "Primary Scale Types", "x-aliases": [ "objective_function_scale_types" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "primary_scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each objective function", "title": "Primary Scales", "x-aliases": [ "objective_function_scales" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "weights": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify weights for each objective function", "title": "Weights", "x-aliases": [ "multi_objective_weights" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_weights", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "nonlinear_inequality_constraints": { "anyOf": [ { "$ref": "#/$defs/ObjectiveFunctionsNonlinearInequalityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear inequality constraints", "x-aliases": [ "num_nonlinear_inequality_constraints" ] }, "nonlinear_equality_constraints": { "anyOf": [ { "$ref": "#/$defs/ObjectiveFunctionsNonlinearEqualityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear equality constraints", "x-aliases": [ "num_nonlinear_equality_constraints" ] }, "scalar_objectives": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar objective functions", "title": "Scalar Objectives", "x-aliases": [ "num_scalar_objectives" ], "x-materialization": [ { "ir_key": "responses.num_scalar_objectives", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_objectives": { "anyOf": [ { "$ref": "#/$defs/FieldObjectives" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field objective functions", "x-aliases": [ "num_field_objectives" ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsConfig", "type": "object", "x-model-validations": [ { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of weights must equal count.", "validationFields": [ "weights", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of sense must equal 1 or count.", "validationFields": [ "sense", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of primary_scale_types must equal 1 or count.", "validationFields": [ "primary_scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scale_types must be one of ['value', 'log', 'none'].", "validationFields": [ "primary_scale_types" ], "validationLiterals": [ "value", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scales must be provided when primary_scale_types includes 'value'.", "validationFields": [ "primary_scale_types", "primary_scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "ObjectiveFunctionsNonlinearEqualityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear equality constraints", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsNonlinearEqualityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "ObjectiveFunctionsNonlinearInequalityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear inequality constraints", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsNonlinearInequalityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] }, "QuasiHessians": { "additionalProperties": false, "description": "Hessians are needed and will be approximated by secant updates (BFGS or SR1) from a series of gradient evaluations", "properties": { "quasi_hessians": { "anyOf": [ { "$ref": "#/$defs/QuasiHessiansBfgs" }, { "$ref": "#/$defs/QuasiHessiansSr1" } ], "description": "Hessians are needed and will be approximated by secant updates (BFGS or SR1) from a series of gradient evaluations", "title": "Quasi Hessians", "x-materialization": [ { "ir_key": "responses.hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "quasi" } ] } }, "required": [ "quasi_hessians" ], "title": "QuasiHessians", "type": "object" }, "QuasiHessiansBfgs": { "additionalProperties": false, "description": "Use BFGS method to compute quasi-hessians", "properties": { "bfgs": { "$ref": "#/$defs/QuasiHessiansBfgsConfig", "x-materialization": [ { "ir_key": "responses.quasi_hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "bfgs" } ] } }, "required": [ "bfgs" ], "title": "QuasiHessiansBfgs", "type": "object" }, "QuasiHessiansBfgsConfig": { "additionalProperties": false, "description": "Use BFGS method to compute quasi-hessians", "properties": { "damped": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Numerical safeguarding for BFGS updates", "title": "Damped", "x-materialization": [ { "ir_key": "responses.quasi_hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "damped_bfgs" } ] } }, "title": "QuasiHessiansBfgsConfig", "type": "object" }, "QuasiHessiansSr1": { "additionalProperties": false, "description": "Use the Symmetric Rank 1 update method to compute quasi-Hessians", "properties": { "sr1": { "const": true, "default": true, "description": "Use the Symmetric Rank 1 update method to compute quasi-Hessians", "title": "Sr1", "type": "boolean", "x-materialization": [ { "ir_key": "responses.quasi_hessian_type", "ir_value_type": "String", "storage_type": "PRESENCE_LITERAL", "stored_value": "sr1" } ] } }, "title": "QuasiHessiansSr1", "type": "object" }, "ResponseFunctions": { "additionalProperties": false, "description": "Generic response type", "properties": { "response_functions": { "$ref": "#/$defs/ResponseFunctionsConfig", "argument": "count", "x-aliases": [ "num_response_functions" ] } }, "required": [ "response_functions" ], "title": "ResponseFunctions", "type": "object" }, "ResponseFunctionsConfig": { "additionalProperties": false, "description": "Generic response type", "properties": { "count": { "description": "Generic response type", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_response_functions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scalar_responses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar response functions", "title": "Scalar Responses", "x-aliases": [ "num_scalar_responses" ], "x-materialization": [ { "ir_key": "responses.num_scalar_responses", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_responses": { "anyOf": [ { "$ref": "#/$defs/FieldResponses" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field responses functions", "x-aliases": [ "num_field_responses" ] } }, "required": [ "count" ], "title": "ResponseFunctionsConfig", "type": "object" }, "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" }, "ScalarDataFile": { "additionalProperties": false, "description": "Specify a scalar data file to complement field data files (mixed case)", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Specify a scalar data file to complement field data files (mixed case)", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "ScalarDataFile", "type": "object" } }, "additionalProperties": false, "required": [ "hessian_type", "gradient_type", "response_type" ], "x-model-validations": [ { "validationContext": "responses", "validationErrorMessage": "For responses, descriptors length must match total number of responses.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_response_descriptors_length" }, { "validationContext": "responses", "validationErrorMessage": "For responses, descriptors must be valid.", "validationFields": [ "descriptors" ], "validationLiterals": [ true ], "validationRuleName": "check_descriptors_valid" }, { "validationContext": "responses", "validationErrorMessage": "For responses, failed to set response descriptors.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_response_descriptors" }, { "validationContext": "responses", "validationErrorMessage": "For responses, vendor numerical gradients only support a single fd_step_size.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_fd_gradient_step_size" }, { "validationContext": "responses", "validationErrorMessage": "For responses, mixed gradient ID lists must cover all functions exactly once.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_mixed_gradients" }, { "validationContext": "responses", "validationErrorMessage": "For responses, mixed Hessian ID lists must cover all functions exactly once.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_mixed_hessians" } ] }
- Fields:
- field descriptors: list[str] | None = None
Labels for the responses
- field gradient_type: NoGradients | AnalyticGradients | MixedGradients | NumericalGradients [Required]
Gradient Type
- field hessian_type: NoHessians | NumericalHessians | QuasiHessians | AnalyticHessians | MixedHessians [Required]
Hessian Type
- field id_responses: str | None = None
Name the responses block; helpful when there are multiple
- field metadata: list[str] | None = None
(Experimental) Labels for floating point response metadata
- field response_type: ObjectiveFunctions | CalibrationTerms | ResponseFunctions [Required]
Response Type
Generated Pydantic models for responses
- pydantic model dakota.spec.responses.CalibrationData
Supply field or mixed field/scalar calibration data
Show JSON schema
{ "title": "CalibrationData", "description": "Supply field or mixed field/scalar calibration data", "type": "object", "properties": { "calibration_data": { "$ref": "#/$defs/CalibrationDataConfig", "x-materialization": [ { "ir_key": "responses.calibration_data", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "CalibrationDataConfig": { "additionalProperties": false, "description": "Supply field or mixed field/scalar calibration data", "properties": { "data_directory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify a directory containing the calibration field data files used with the mixed case specification", "title": "Data Directory", "x-materialization": [ { "ir_key": "responses.data_directory", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scalar_data_file": { "anyOf": [ { "$ref": "#/$defs/ScalarDataFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "Specify a scalar data file to complement field data files (mixed case)" }, "interpolate": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Flag to indicate interpolation of simulation values.", "title": "Interpolate", "x-materialization": [ { "ir_key": "responses.interpolate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "CalibrationDataConfig", "type": "object" }, "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" }, "ScalarDataFile": { "additionalProperties": false, "description": "Specify a scalar data file to complement field data files (mixed case)", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Specify a scalar data file to complement field data files (mixed case)", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "ScalarDataFile", "type": "object" } }, "additionalProperties": false, "required": [ "calibration_data" ] }
- field calibration_data: CalibrationDataConfig [Required]
Supply field or mixed field/scalar calibration data
- pydantic model dakota.spec.responses.CalibrationDataConfig
Supply field or mixed field/scalar calibration data
Show JSON schema
{ "title": "CalibrationDataConfig", "description": "Supply field or mixed field/scalar calibration data", "type": "object", "properties": { "data_directory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify a directory containing the calibration field data files used with the mixed case specification", "title": "Data Directory", "x-materialization": [ { "ir_key": "responses.data_directory", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scalar_data_file": { "anyOf": [ { "$ref": "#/$defs/ScalarDataFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "Specify a scalar data file to complement field data files (mixed case)" }, "interpolate": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Flag to indicate interpolation of simulation values.", "title": "Interpolate", "x-materialization": [ { "ir_key": "responses.interpolate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "$defs": { "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" }, "ScalarDataFile": { "additionalProperties": false, "description": "Specify a scalar data file to complement field data files (mixed case)", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Specify a scalar data file to complement field data files (mixed case)", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "ScalarDataFile", "type": "object" } }, "additionalProperties": false }
- Fields:
- field data_directory: str | None = None
Specify a directory containing the calibration field data files used with the mixed case specification
- field experiment_variance_type: list[str] | None = None
Add context to data: specify the type of experimental error
- field interpolate: Literal[True] | None = None
Flag to indicate interpolation of simulation values.
- field num_config_variables: int | None = None
Add context to data: number of configuration variables.
- Constraints:
ge = 0
- field num_experiments: int = 1
Add context to data: number of different experiments
- Constraints:
ge = 0
- field scalar_data_file: ScalarDataFile | None = None
Specify a scalar data file to complement field data files (mixed case)
- pydantic model dakota.spec.responses.CalibrationDataFile
Supply scalar calibration data only
Show JSON schema
{ "title": "CalibrationDataFile", "description": "Supply scalar calibration data only", "type": "object", "properties": { "calibration_data_file": { "$ref": "#/$defs/CalibrationDataFileConfig", "argument": "filename", "x-aliases": [ "least_squares_data_file" ] } }, "$defs": { "CalibrationDataFileConfig": { "additionalProperties": false, "description": "Supply scalar calibration data only", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Supply scalar calibration data only", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "CalibrationDataFileConfig", "type": "object" }, "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" } }, "additionalProperties": false, "required": [ "calibration_data_file" ] }
- field calibration_data_file: CalibrationDataFileConfig [Required]
Supply scalar calibration data only
- pydantic model dakota.spec.responses.CalibrationDataFileConfig
Supply scalar calibration data only
Show JSON schema
{ "title": "CalibrationDataFileConfig", "description": "Supply scalar calibration data only", "type": "object", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Supply scalar calibration data only", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" } }, "additionalProperties": false, "required": [ "filename" ] }
- Fields:
- field experiment_variance_type: list[str] | None = None
Add context to data: specify the type of experimental error
- field filename: str [Required]
Supply scalar calibration data only
- field format: ResponseScalarDataFormatCustomAnnotated | ResponseScalarDataFormatAnnotated | ResponseScalarDataFormatFreeform [Optional]
Tabular Format
- field num_config_variables: int | None = None
Add context to data: number of configuration variables.
- Constraints:
ge = 0
- field num_experiments: int = 1
Add context to data: number of different experiments
- Constraints:
ge = 0
- pydantic model dakota.spec.responses.CalibrationTerms
Response type suitable for calibration or least squares
Show JSON schema
{ "title": "CalibrationTerms", "description": "Response type suitable for calibration or least squares", "type": "object", "properties": { "calibration_terms": { "$ref": "#/$defs/CalibrationTermsConfig", "argument": "count", "x-aliases": [ "least_squares_terms", "num_least_squares_terms" ] } }, "$defs": { "CalibrationData": { "additionalProperties": false, "description": "Supply field or mixed field/scalar calibration data", "properties": { "calibration_data": { "$ref": "#/$defs/CalibrationDataConfig", "x-materialization": [ { "ir_key": "responses.calibration_data", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "calibration_data" ], "title": "CalibrationData", "type": "object" }, "CalibrationDataConfig": { "additionalProperties": false, "description": "Supply field or mixed field/scalar calibration data", "properties": { "data_directory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify a directory containing the calibration field data files used with the mixed case specification", "title": "Data Directory", "x-materialization": [ { "ir_key": "responses.data_directory", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scalar_data_file": { "anyOf": [ { "$ref": "#/$defs/ScalarDataFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "Specify a scalar data file to complement field data files (mixed case)" }, "interpolate": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Flag to indicate interpolation of simulation values.", "title": "Interpolate", "x-materialization": [ { "ir_key": "responses.interpolate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "CalibrationDataConfig", "type": "object" }, "CalibrationDataFile": { "additionalProperties": false, "description": "Supply scalar calibration data only", "properties": { "calibration_data_file": { "$ref": "#/$defs/CalibrationDataFileConfig", "argument": "filename", "x-aliases": [ "least_squares_data_file" ] } }, "required": [ "calibration_data_file" ], "title": "CalibrationDataFile", "type": "object" }, "CalibrationDataFileConfig": { "additionalProperties": false, "description": "Supply scalar calibration data only", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Supply scalar calibration data only", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "CalibrationDataFileConfig", "type": "object" }, "CalibrationTermsConfig": { "additionalProperties": false, "description": "Response type suitable for calibration or least squares", "properties": { "count": { "description": "Response type suitable for calibration or least squares", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scalar_calibration_terms": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar calibration terms", "title": "Scalar Calibration Terms", "x-materialization": [ { "ir_key": "responses.num_scalar_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_calibration_terms": { "anyOf": [ { "$ref": "#/$defs/FieldCalibrationTerms" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field calibration terms" }, "primary_scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each calibration term", "title": "Primary Scales", "x-aliases": [ "calibration_term_scales", "least_squares_term_scales" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "weights": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify weights for each objective function", "title": "Weights", "x-aliases": [ "calibration_weights", "least_squares_weights" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_weights", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "data_specification": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/CalibrationData" }, { "$ref": "#/$defs/CalibrationDataFile" }, { "type": "null" } ], "default": null, "description": "Calibration Data", "title": "Data Specification", "x-union-pattern": 2 }, "simulation_variance": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Variance applied to simulation responses", "title": "Simulation Variance", "x-materialization": [ { "ir_key": "responses.simulation_variance", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "nonlinear_inequality_constraints": { "anyOf": [ { "$ref": "#/$defs/CalibrationTermsNonlinearInequalityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear inequality constraints", "x-aliases": [ "num_nonlinear_inequality_constraints" ] }, "nonlinear_equality_constraints": { "anyOf": [ { "$ref": "#/$defs/CalibrationTermsNonlinearEqualityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear equality constraints", "x-aliases": [ "num_nonlinear_equality_constraints" ] } }, "required": [ "count" ], "title": "CalibrationTermsConfig", "type": "object", "x-model-validations": [ { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of weights must equal count.", "validationFields": [ "weights", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of simulation_variance must equal 1 or count.", "validationFields": [ "simulation_variance", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of data_specification.calibration_data.experiment_variance_type must equal 1 or count.", "validationFields": [ "data_specification.calibration_data.experiment_variance_type", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of data_specification.calibration_data_file.experiment_variance_type must equal 1 or count.", "validationFields": [ "data_specification.calibration_data_file.experiment_variance_type", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" } ] }, "CalibrationTermsNonlinearEqualityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear equality constraints", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "CalibrationTermsNonlinearEqualityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "CalibrationTermsNonlinearInequalityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear inequality constraints", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "CalibrationTermsNonlinearInequalityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] }, "FieldCalibrationTerms": { "additionalProperties": false, "description": "Number of field calibration terms", "properties": { "count": { "description": "Number of field calibration terms", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldCalibrationTerms", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_field_calibration_terms", "validationErrorMessage": "For responses_calibration_terms_field_calibration_terms, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" }, "ScalarDataFile": { "additionalProperties": false, "description": "Specify a scalar data file to complement field data files (mixed case)", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Specify a scalar data file to complement field data files (mixed case)", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "ScalarDataFile", "type": "object" } }, "additionalProperties": false, "required": [ "calibration_terms" ] }
- field calibration_terms: CalibrationTermsConfig [Required]
Response type suitable for calibration or least squares
- pydantic model dakota.spec.responses.CalibrationTermsConfig
Response type suitable for calibration or least squares
Show JSON schema
{ "title": "CalibrationTermsConfig", "description": "Response type suitable for calibration or least squares", "type": "object", "properties": { "count": { "description": "Response type suitable for calibration or least squares", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scalar_calibration_terms": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar calibration terms", "title": "Scalar Calibration Terms", "x-materialization": [ { "ir_key": "responses.num_scalar_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_calibration_terms": { "anyOf": [ { "$ref": "#/$defs/FieldCalibrationTerms" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field calibration terms" }, "primary_scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each calibration term", "title": "Primary Scales", "x-aliases": [ "calibration_term_scales", "least_squares_term_scales" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "weights": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify weights for each objective function", "title": "Weights", "x-aliases": [ "calibration_weights", "least_squares_weights" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_weights", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "data_specification": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/CalibrationData" }, { "$ref": "#/$defs/CalibrationDataFile" }, { "type": "null" } ], "default": null, "description": "Calibration Data", "title": "Data Specification", "x-union-pattern": 2 }, "simulation_variance": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Variance applied to simulation responses", "title": "Simulation Variance", "x-materialization": [ { "ir_key": "responses.simulation_variance", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "nonlinear_inequality_constraints": { "anyOf": [ { "$ref": "#/$defs/CalibrationTermsNonlinearInequalityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear inequality constraints", "x-aliases": [ "num_nonlinear_inequality_constraints" ] }, "nonlinear_equality_constraints": { "anyOf": [ { "$ref": "#/$defs/CalibrationTermsNonlinearEqualityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear equality constraints", "x-aliases": [ "num_nonlinear_equality_constraints" ] } }, "$defs": { "CalibrationData": { "additionalProperties": false, "description": "Supply field or mixed field/scalar calibration data", "properties": { "calibration_data": { "$ref": "#/$defs/CalibrationDataConfig", "x-materialization": [ { "ir_key": "responses.calibration_data", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "calibration_data" ], "title": "CalibrationData", "type": "object" }, "CalibrationDataConfig": { "additionalProperties": false, "description": "Supply field or mixed field/scalar calibration data", "properties": { "data_directory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Specify a directory containing the calibration field data files used with the mixed case specification", "title": "Data Directory", "x-materialization": [ { "ir_key": "responses.data_directory", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scalar_data_file": { "anyOf": [ { "$ref": "#/$defs/ScalarDataFile" }, { "type": "null" } ], "argument": "filename", "default": null, "description": "Specify a scalar data file to complement field data files (mixed case)" }, "interpolate": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Flag to indicate interpolation of simulation values.", "title": "Interpolate", "x-materialization": [ { "ir_key": "responses.interpolate", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "title": "CalibrationDataConfig", "type": "object" }, "CalibrationDataFile": { "additionalProperties": false, "description": "Supply scalar calibration data only", "properties": { "calibration_data_file": { "$ref": "#/$defs/CalibrationDataFileConfig", "argument": "filename", "x-aliases": [ "least_squares_data_file" ] } }, "required": [ "calibration_data_file" ], "title": "CalibrationDataFile", "type": "object" }, "CalibrationDataFileConfig": { "additionalProperties": false, "description": "Supply scalar calibration data only", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Supply scalar calibration data only", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] }, "num_experiments": { "default": 1, "description": "Add context to data: number of different experiments", "minimum": 0, "title": "Num Experiments", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_experiments", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "num_config_variables": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Add context to data: number of configuration variables.", "title": "Num Config Variables", "x-materialization": [ { "ir_key": "responses.num_config_vars", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "experiment_variance_type": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Add context to data: specify the type of experimental error", "title": "Experiment Variance Type", "x-aliases": [ "variance_type" ], "x-materialization": [ { "ir_key": "responses.variance_type", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "CalibrationDataFileConfig", "type": "object" }, "CalibrationTermsNonlinearEqualityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear equality constraints", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "CalibrationTermsNonlinearEqualityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "CalibrationTermsNonlinearInequalityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear inequality constraints", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "CalibrationTermsNonlinearInequalityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] }, "FieldCalibrationTerms": { "additionalProperties": false, "description": "Number of field calibration terms", "properties": { "count": { "description": "Number of field calibration terms", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldCalibrationTerms", "type": "object", "x-model-validations": [ { "validationContext": "responses_calibration_terms_field_calibration_terms", "validationErrorMessage": "For responses_calibration_terms_field_calibration_terms, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" }, "ScalarDataFile": { "additionalProperties": false, "description": "Specify a scalar data file to complement field data files (mixed case)", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Specify a scalar data file to complement field data files (mixed case)", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "filename" ], "title": "ScalarDataFile", "type": "object" } }, "additionalProperties": false, "required": [ "count" ], "x-model-validations": [ { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of weights must equal count.", "validationFields": [ "weights", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of simulation_variance must equal 1 or count.", "validationFields": [ "simulation_variance", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of data_specification.calibration_data.experiment_variance_type must equal 1 or count.", "validationFields": [ "data_specification.calibration_data.experiment_variance_type", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "calibration_terms", "validationErrorMessage": "For calibration_terms, length of data_specification.calibration_data_file.experiment_variance_type must equal 1 or count.", "validationFields": [ "data_specification.calibration_data_file.experiment_variance_type", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" } ] }
- field count: int [Required]
Response type suitable for calibration or least squares
- Constraints:
ge = 0
- field data_specification: CalibrationData | CalibrationDataFile | None = None
Calibration Data
- field field_calibration_terms: FieldCalibrationTerms | None = None
Number of field calibration terms
- field nonlinear_equality_constraints: CalibrationTermsNonlinearEqualityConstraints | None = None
Group to specify nonlinear equality constraints
- field nonlinear_inequality_constraints: CalibrationTermsNonlinearInequalityConstraints | None = None
Group to specify nonlinear inequality constraints
- field primary_scales: list[DakotaFloat] | None = None
Characteristic values to scale each calibration term
- field scalar_calibration_terms: int | None = None
Number of scalar calibration terms
- Constraints:
ge = 0
- field simulation_variance: list[DakotaFloat] | None = None
Variance applied to simulation responses
- field weights: list[DakotaFloat] | None = None
Specify weights for each objective function
- pydantic model dakota.spec.responses.CalibrationTermsNonlinearEqualityConstraints
Group to specify nonlinear equality constraints
Show JSON schema
{ "title": "CalibrationTermsNonlinearEqualityConstraints", "description": "Group to specify nonlinear equality constraints", "type": "object", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "count" ], "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_equality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }
- Fields:
- field count: int [Required]
Group to specify nonlinear equality constraints
- Constraints:
ge = 0
- field scale_types: list[str] | None = None
How to scale each nonlinear constraint
- field scales: list[DakotaFloat] | None = None
Characteristic values to scale each nonlinear constraint
- field targets: list[DakotaFloat] | None = None
Target values for the nonlinear equality constraint
- pydantic model dakota.spec.responses.CalibrationTermsNonlinearInequalityConstraints
Group to specify nonlinear inequality constraints
Show JSON schema
{ "title": "CalibrationTermsNonlinearInequalityConstraints", "description": "Group to specify nonlinear inequality constraints", "type": "object", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "count" ], "x-model-validations": [ { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_calibration_terms_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_calibration_terms_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] }
- Fields:
- field count: int [Required]
Group to specify nonlinear inequality constraints
- Constraints:
ge = 0
- field lower_bounds: list[DakotaFloat] | None = None
Specify minimum values
- field scale_types: list[str] | None = None
How to scale each nonlinear constraint
- field scales: list[DakotaFloat] | None = None
Characteristic values to scale each nonlinear constraint
- field upper_bounds: list[DakotaFloat] | None = None
Specify maximium values
- pydantic model dakota.spec.responses.FieldCalibrationTerms
Number of field calibration terms
Show JSON schema
{ "title": "FieldCalibrationTerms", "description": "Number of field calibration terms", "type": "object", "properties": { "count": { "description": "Number of field calibration terms", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_calibration_terms", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false, "required": [ "count", "lengths" ], "x-model-validations": [ { "validationContext": "responses_calibration_terms_field_calibration_terms", "validationErrorMessage": "For responses_calibration_terms_field_calibration_terms, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }
- Fields:
- field count: int [Required]
Number of field calibration terms
- Constraints:
ge = 0
- field lengths: list[int] [Required]
Lengths of field responses
- field num_coordinates_per_field: list[int] | None = None
Number of independent coordinates for field responses
- field read_field_coordinates: Literal[True] | None = None
Add context to data: flag to indicate that field coordinates should be read
- pydantic model dakota.spec.responses.FieldObjectives
Number of field objective functions
Show JSON schema
{ "title": "FieldObjectives", "description": "Number of field objective functions", "type": "object", "properties": { "count": { "description": "Number of field objective functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_objectives", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false, "required": [ "count", "lengths" ], "x-model-validations": [ { "validationContext": "responses_objective_functions_field_objectives", "validationErrorMessage": "For responses_objective_functions_field_objectives, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }
- Fields:
- field count: int [Required]
Number of field objective functions
- Constraints:
ge = 0
- field lengths: list[int] [Required]
Lengths of field responses
- field num_coordinates_per_field: list[int] | None = None
Number of independent coordinates for field responses
- field read_field_coordinates: Literal[True] | None = None
Add context to data: flag to indicate that field coordinates should be read
- pydantic model dakota.spec.responses.FieldResponses
Number of field responses functions
Show JSON schema
{ "title": "FieldResponses", "description": "Number of field responses functions", "type": "object", "properties": { "count": { "description": "Number of field responses functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_responses", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "additionalProperties": false, "required": [ "count", "lengths" ], "x-model-validations": [ { "validationContext": "responses_response_functions_field_responses", "validationErrorMessage": "For responses_response_functions_field_responses, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }
- Fields:
- field count: int [Required]
Number of field responses functions
- Constraints:
ge = 0
- field lengths: list[int] [Required]
Lengths of field responses
- field num_coordinates_per_field: list[int] | None = None
Number of independent coordinates for field responses
- field read_field_coordinates: Literal[True] | None = None
Add context to data: flag to indicate that field coordinates should be read
- pydantic model dakota.spec.responses.ObjectiveFunctions
Response type suitable for optimization
Show JSON schema
{ "title": "ObjectiveFunctions", "description": "Response type suitable for optimization", "type": "object", "properties": { "objective_functions": { "$ref": "#/$defs/ObjectiveFunctionsConfig", "argument": "count", "x-aliases": [ "num_objective_functions" ] } }, "$defs": { "FieldObjectives": { "additionalProperties": false, "description": "Number of field objective functions", "properties": { "count": { "description": "Number of field objective functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_objectives", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldObjectives", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_field_objectives", "validationErrorMessage": "For responses_objective_functions_field_objectives, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "ObjectiveFunctionsConfig": { "additionalProperties": false, "description": "Response type suitable for optimization", "properties": { "count": { "description": "Response type suitable for optimization", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_objective_functions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "sense": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Whether to minimize or maximize each objective function", "title": "Sense", "x-materialization": [ { "ir_key": "responses.primary_response_fn_sense", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "primary_scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each objective function", "title": "Primary Scale Types", "x-aliases": [ "objective_function_scale_types" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "primary_scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each objective function", "title": "Primary Scales", "x-aliases": [ "objective_function_scales" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "weights": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify weights for each objective function", "title": "Weights", "x-aliases": [ "multi_objective_weights" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_weights", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "nonlinear_inequality_constraints": { "anyOf": [ { "$ref": "#/$defs/ObjectiveFunctionsNonlinearInequalityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear inequality constraints", "x-aliases": [ "num_nonlinear_inequality_constraints" ] }, "nonlinear_equality_constraints": { "anyOf": [ { "$ref": "#/$defs/ObjectiveFunctionsNonlinearEqualityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear equality constraints", "x-aliases": [ "num_nonlinear_equality_constraints" ] }, "scalar_objectives": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar objective functions", "title": "Scalar Objectives", "x-aliases": [ "num_scalar_objectives" ], "x-materialization": [ { "ir_key": "responses.num_scalar_objectives", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_objectives": { "anyOf": [ { "$ref": "#/$defs/FieldObjectives" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field objective functions", "x-aliases": [ "num_field_objectives" ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsConfig", "type": "object", "x-model-validations": [ { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of weights must equal count.", "validationFields": [ "weights", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of sense must equal 1 or count.", "validationFields": [ "sense", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of primary_scale_types must equal 1 or count.", "validationFields": [ "primary_scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scale_types must be one of ['value', 'log', 'none'].", "validationFields": [ "primary_scale_types" ], "validationLiterals": [ "value", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scales must be provided when primary_scale_types includes 'value'.", "validationFields": [ "primary_scale_types", "primary_scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "ObjectiveFunctionsNonlinearEqualityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear equality constraints", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsNonlinearEqualityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "ObjectiveFunctionsNonlinearInequalityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear inequality constraints", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsNonlinearInequalityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] } }, "additionalProperties": false, "required": [ "objective_functions" ], "x-model-validations": [ { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scale_types must be one of ['value', 'log', 'none'].", "validationFields": [ "primary_scale_types" ], "validationLiterals": [ "value", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scales must be provided when primary_scale_types includes 'value'.", "validationFields": [ "primary_scale_types", "primary_scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }
- field objective_functions: ObjectiveFunctionsConfig [Required]
Response type suitable for optimization
- pydantic model dakota.spec.responses.ObjectiveFunctionsConfig
Response type suitable for optimization
Show JSON schema
{ "title": "ObjectiveFunctionsConfig", "description": "Response type suitable for optimization", "type": "object", "properties": { "count": { "description": "Response type suitable for optimization", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_objective_functions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "sense": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Whether to minimize or maximize each objective function", "title": "Sense", "x-materialization": [ { "ir_key": "responses.primary_response_fn_sense", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "primary_scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each objective function", "title": "Primary Scale Types", "x-aliases": [ "objective_function_scale_types" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "primary_scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each objective function", "title": "Primary Scales", "x-aliases": [ "objective_function_scales" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "weights": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify weights for each objective function", "title": "Weights", "x-aliases": [ "multi_objective_weights" ], "x-materialization": [ { "ir_key": "responses.primary_response_fn_weights", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "nonlinear_inequality_constraints": { "anyOf": [ { "$ref": "#/$defs/ObjectiveFunctionsNonlinearInequalityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear inequality constraints", "x-aliases": [ "num_nonlinear_inequality_constraints" ] }, "nonlinear_equality_constraints": { "anyOf": [ { "$ref": "#/$defs/ObjectiveFunctionsNonlinearEqualityConstraints" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Group to specify nonlinear equality constraints", "x-aliases": [ "num_nonlinear_equality_constraints" ] }, "scalar_objectives": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar objective functions", "title": "Scalar Objectives", "x-aliases": [ "num_scalar_objectives" ], "x-materialization": [ { "ir_key": "responses.num_scalar_objectives", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_objectives": { "anyOf": [ { "$ref": "#/$defs/FieldObjectives" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field objective functions", "x-aliases": [ "num_field_objectives" ] } }, "$defs": { "FieldObjectives": { "additionalProperties": false, "description": "Number of field objective functions", "properties": { "count": { "description": "Number of field objective functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_objectives", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldObjectives", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_field_objectives", "validationErrorMessage": "For responses_objective_functions_field_objectives, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "ObjectiveFunctionsNonlinearEqualityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear equality constraints", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsNonlinearEqualityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }, "ObjectiveFunctionsNonlinearInequalityConstraints": { "additionalProperties": false, "description": "Group to specify nonlinear inequality constraints", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "required": [ "count" ], "title": "ObjectiveFunctionsNonlinearInequalityConstraints", "type": "object", "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] } }, "additionalProperties": false, "required": [ "count" ], "x-model-validations": [ { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of weights must equal count.", "validationFields": [ "weights", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of sense must equal 1 or count.", "validationFields": [ "sense", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, length of primary_scale_types must equal 1 or count.", "validationFields": [ "primary_scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scale_types must be one of ['value', 'log', 'none'].", "validationFields": [ "primary_scale_types" ], "validationLiterals": [ "value", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "objective_functions", "validationErrorMessage": "For objective_functions, primary_scales must be provided when primary_scale_types includes 'value'.", "validationFields": [ "primary_scale_types", "primary_scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }
- field count: int [Required]
Response type suitable for optimization
- Constraints:
ge = 0
- field field_objectives: FieldObjectives | None = None
Number of field objective functions
- field nonlinear_equality_constraints: ObjectiveFunctionsNonlinearEqualityConstraints | None = None
Group to specify nonlinear equality constraints
- field nonlinear_inequality_constraints: ObjectiveFunctionsNonlinearInequalityConstraints | None = None
Group to specify nonlinear inequality constraints
- field primary_scale_types: list[str] | None = None
How to scale each objective function
- field primary_scales: list[DakotaFloat] | None = None
Characteristic values to scale each objective function
- field scalar_objectives: int | None = None
Number of scalar objective functions
- Constraints:
ge = 0
- field sense: list[str] | None = None
Whether to minimize or maximize each objective function
- field weights: list[DakotaFloat] | None = None
Specify weights for each objective function
- pydantic model dakota.spec.responses.ObjectiveFunctionsNonlinearEqualityConstraints
Group to specify nonlinear equality constraints
Show JSON schema
{ "title": "ObjectiveFunctionsNonlinearEqualityConstraints", "description": "Group to specify nonlinear equality constraints", "type": "object", "properties": { "count": { "description": "Group to specify nonlinear equality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_equality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "targets": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Target values for the nonlinear equality constraint", "title": "Targets", "x-aliases": [ "nonlinear_equality_targets" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_targets", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_equality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_equality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_equality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "count" ], "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of targets must equal count.", "validationFields": [ "targets", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_equality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_equality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, failed to set equality constraint targets.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_equality_targets" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_equality_constraints", "validationErrorMessage": "For nonlinear_equality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" } ] }
- Fields:
- field count: int [Required]
Group to specify nonlinear equality constraints
- Constraints:
ge = 0
- field scale_types: list[str] | None = None
How to scale each nonlinear constraint
- field scales: list[DakotaFloat] | None = None
Characteristic values to scale each nonlinear constraint
- field targets: list[DakotaFloat] | None = None
Target values for the nonlinear equality constraint
- pydantic model dakota.spec.responses.ObjectiveFunctionsNonlinearInequalityConstraints
Group to specify nonlinear inequality constraints
Show JSON schema
{ "title": "ObjectiveFunctionsNonlinearInequalityConstraints", "description": "Group to specify nonlinear inequality constraints", "type": "object", "properties": { "count": { "description": "Group to specify nonlinear inequality constraints", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_nonlinear_inequality_constraints", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lower_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify minimum values", "title": "Lower Bounds", "x-aliases": [ "nonlinear_inequality_lower_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_lower_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "upper_bounds": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Specify maximium values", "title": "Upper Bounds", "x-aliases": [ "nonlinear_inequality_upper_bounds" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_upper_bounds", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] }, "scale_types": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "How to scale each nonlinear constraint", "title": "Scale Types", "x-aliases": [ "nonlinear_inequality_scale_types" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scale_types", "ir_value_type": "StringArray", "storage_type": "DIRECT_VALUE" } ] }, "scales": { "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Characteristic values to scale each nonlinear constraint", "title": "Scales", "x-aliases": [ "nonlinear_inequality_scales" ], "x-materialization": [ { "ir_key": "responses.nonlinear_inequality_scales", "ir_value_type": "RealVector", "storage_type": "DIRECT_VALUE" } ] } }, "additionalProperties": false, "required": [ "count" ], "x-model-validations": [ { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of lower_bounds must equal count.", "validationFields": [ "lower_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of upper_bounds must equal count.", "validationFields": [ "upper_bounds", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scale_types must equal 1 or count.", "validationFields": [ "scale_types", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "responses_objective_functions_nonlinear_inequality_constraints", "validationErrorMessage": "For responses_objective_functions_nonlinear_inequality_constraints, length of scales must equal 1 or count.", "validationFields": [ "scales", "count" ], "validationLiterals": [], "validationRuleName": "compare_len1" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, failed to set inequality constraint bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "default_inequality_bounds" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scale_types must be one of ['value', 'auto', 'log', 'none'].", "validationFields": [ "scale_types" ], "validationLiterals": [ "value", "auto", "log", "none" ], "validationRuleName": "check_permitted_values" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, scales must be provided when scale_types includes 'value'.", "validationFields": [ "scale_types", "scales" ], "validationLiterals": [], "validationRuleName": "check_scales_required" }, { "validationContext": "nonlinear_inequality_constraints", "validationErrorMessage": "For nonlinear_inequality_constraints, lower_bounds must not exceed upper_bounds.", "validationFields": [], "validationLiterals": [], "validationRuleName": "check_constraint_bounds_ordering" } ] }
- Fields:
- field count: int [Required]
Group to specify nonlinear inequality constraints
- Constraints:
ge = 0
- field lower_bounds: list[DakotaFloat] | None = None
Specify minimum values
- field scale_types: list[str] | None = None
How to scale each nonlinear constraint
- field scales: list[DakotaFloat] | None = None
Characteristic values to scale each nonlinear constraint
- field upper_bounds: list[DakotaFloat] | None = None
Specify maximium values
- pydantic model dakota.spec.responses.ResponseFunctions
Generic response type
Show JSON schema
{ "title": "ResponseFunctions", "description": "Generic response type", "type": "object", "properties": { "response_functions": { "$ref": "#/$defs/ResponseFunctionsConfig", "argument": "count", "x-aliases": [ "num_response_functions" ] } }, "$defs": { "FieldResponses": { "additionalProperties": false, "description": "Number of field responses functions", "properties": { "count": { "description": "Number of field responses functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_responses", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldResponses", "type": "object", "x-model-validations": [ { "validationContext": "responses_response_functions_field_responses", "validationErrorMessage": "For responses_response_functions_field_responses, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] }, "ResponseFunctionsConfig": { "additionalProperties": false, "description": "Generic response type", "properties": { "count": { "description": "Generic response type", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_response_functions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scalar_responses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar response functions", "title": "Scalar Responses", "x-aliases": [ "num_scalar_responses" ], "x-materialization": [ { "ir_key": "responses.num_scalar_responses", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_responses": { "anyOf": [ { "$ref": "#/$defs/FieldResponses" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field responses functions", "x-aliases": [ "num_field_responses" ] } }, "required": [ "count" ], "title": "ResponseFunctionsConfig", "type": "object" } }, "additionalProperties": false, "required": [ "response_functions" ] }
- field response_functions: ResponseFunctionsConfig [Required]
Generic response type
- pydantic model dakota.spec.responses.ResponseFunctionsConfig
Generic response type
Show JSON schema
{ "title": "ResponseFunctionsConfig", "description": "Generic response type", "type": "object", "properties": { "count": { "description": "Generic response type", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_response_functions", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "scalar_responses": { "anyOf": [ { "minimum": 0, "type": "integer" }, { "type": "null" } ], "default": null, "description": "Number of scalar response functions", "title": "Scalar Responses", "x-aliases": [ "num_scalar_responses" ], "x-materialization": [ { "ir_key": "responses.num_scalar_responses", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "field_responses": { "anyOf": [ { "$ref": "#/$defs/FieldResponses" }, { "type": "null" } ], "argument": "count", "default": null, "description": "Number of field responses functions", "x-aliases": [ "num_field_responses" ] } }, "$defs": { "FieldResponses": { "additionalProperties": false, "description": "Number of field responses functions", "properties": { "count": { "description": "Number of field responses functions", "minimum": 0, "title": "Count", "type": "integer", "x-materialization": [ { "ir_key": "responses.num_field_responses", "ir_value_type": "size_t", "storage_type": "DIRECT_VALUE" } ] }, "lengths": { "description": "Lengths of field responses", "items": { "type": "integer" }, "title": "Lengths", "type": "array", "x-materialization": [ { "ir_key": "responses.lengths", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "num_coordinates_per_field": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "default": null, "description": "Number of independent coordinates for field responses", "title": "Num Coordinates Per Field", "x-materialization": [ { "ir_key": "responses.num_coordinates_per_field", "ir_value_type": "IntVector", "storage_type": "DIRECT_VALUE" } ] }, "read_field_coordinates": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Add context to data: flag to indicate that field coordinates should be read", "title": "Read Field Coordinates", "x-materialization": [ { "ir_key": "responses.read_field_coordinates", "ir_value_type": "bool", "storage_type": "PRESENCE_TRUE" } ] } }, "required": [ "count", "lengths" ], "title": "FieldResponses", "type": "object", "x-model-validations": [ { "validationContext": "responses_response_functions_field_responses", "validationErrorMessage": "For responses_response_functions_field_responses, length of lengths must equal count.", "validationFields": [ "lengths", "count" ], "validationLiterals": [], "validationRuleName": "compare_len" } ] } }, "additionalProperties": false, "required": [ "count" ] }
- Fields:
- field count: int [Required]
Generic response type
- Constraints:
ge = 0
- field field_responses: FieldResponses | None = None
Number of field responses functions
- field scalar_responses: int | None = None
Number of scalar response functions
- Constraints:
ge = 0
- pydantic model dakota.spec.responses.ScalarDataFile
Specify a scalar data file to complement field data files (mixed case)
Show JSON schema
{ "title": "ScalarDataFile", "description": "Specify a scalar data file to complement field data files (mixed case)", "type": "object", "properties": { "format": { "anchor": true, "anyOf": [ { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatAnnotated" }, { "$ref": "#/$defs/ResponseScalarDataFormatFreeform" } ], "description": "Tabular Format", "title": "Format", "x-model-default": "ResponseScalarDataFormatAnnotated", "x-union-pattern": 1 }, "filename": { "description": "Specify a scalar data file to complement field data files (mixed case)", "title": "Filename", "type": "string", "x-materialization": [ { "ir_key": "responses.scalar_data_filename", "ir_value_type": "String", "storage_type": "DIRECT_VALUE" } ] } }, "$defs": { "ResponseScalarDataFormatAnnotated": { "additionalProperties": false, "description": "Selects annotated tabular file format for experiment data", "properties": { "annotated": { "const": true, "default": true, "description": "Selects annotated tabular file format for experiment data", "title": "Annotated", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_EXPER_ANNOT" } ] } }, "title": "ResponseScalarDataFormatAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotated": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "properties": { "custom_annotated": { "$ref": "#/$defs/ResponseScalarDataFormatCustomAnnotatedConfig", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ], "x-model-default": "ResponseScalarDataFormatCustomAnnotatedConfig" } }, "title": "ResponseScalarDataFormatCustomAnnotated", "type": "object" }, "ResponseScalarDataFormatCustomAnnotatedConfig": { "additionalProperties": false, "description": "Selects custom-annotated tabular file format for experiment data", "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": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_HEADER" } ] }, "exp_id": { "anyOf": [ { "const": true, "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Enable experiment ID column in custom-annotated tabular file", "title": "Exp Id", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "AUGMENT_ENUM", "stored_value": "TABULAR_EVAL_ID" } ] } }, "title": "ResponseScalarDataFormatCustomAnnotatedConfig", "type": "object" }, "ResponseScalarDataFormatFreeform": { "additionalProperties": false, "description": "Selects free-form tabular file format for experiment data", "properties": { "freeform": { "const": true, "default": true, "description": "Selects free-form tabular file format for experiment data", "title": "Freeform", "type": "boolean", "x-materialization": [ { "ir_key": "responses.scalar_data_format", "ir_value_type": "unsigned short", "storage_type": "PRESENCE_ENUM", "stored_value": "TABULAR_NONE" } ] } }, "title": "ResponseScalarDataFormatFreeform", "type": "object" } }, "additionalProperties": false, "required": [ "filename" ] }
- Fields:
- field filename: str [Required]
Specify a scalar data file to complement field data files (mixed case)
- field format: ResponseScalarDataFormatCustomAnnotated | ResponseScalarDataFormatAnnotated | ResponseScalarDataFormatFreeform [Optional]
Tabular Format
