Responses

Generated Pydantic models for shared.responses

class dakota.spec.shared.responses.NoGradients(*, no_gradients: Literal[True] = True)

Gradients will not be used

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.AnalyticGradients(*, analytic_gradients: Literal[True] = True)

Analysis driver will return gradients

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsMethodSourceDakotaRelative(*, relative: Literal[True] = True)

(Default) Scale step size by the parameter value

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsMethodSourceDakotaAbsolute(*, absolute: Literal[True] = True)

Do not scale step-size

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsMethodSourceDakotaBounds(*, bounds: Literal[True] = True)

Scale step-size by the domain of the parameter

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsMethodSourceVendor(*, vendor: Literal[True] = True)

Use non-Dakota fd algorithm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsIntervalTypeForward(*, forward: Literal[True] = True)

(Default) Use forward differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsIntervalTypeCentral(*, central: Literal[True] = True)

Use central differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsMethodSourceDakotaRelative(*, relative: Literal[True] = True)

(Default) Scale step size by the parameter value

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsMethodSourceDakotaAbsolute(*, absolute: Literal[True] = True)

Do not scale step-size

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsMethodSourceDakotaBounds(*, bounds: Literal[True] = True)

Scale step-size by the domain of the parameter

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsMethodSourceVendor(*, vendor: Literal[True] = True)

Use non-Dakota fd algorithm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsIntervalTypeForward(*, forward: Literal[True] = True)

(Default) Use forward differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsIntervalTypeCentral(*, central: Literal[True] = True)

Use central differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NoHessians(*, no_hessians: Literal[True] = True)

Hessians will not be used

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalHessiansRelative(*, relative: Literal[True] = True)

(Default) Scale step size by the parameter value

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalHessiansAbsolute(*, absolute: Literal[True] = True)

Do not scale step-size

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalHessiansBounds(*, bounds: Literal[True] = True)

Scale step-size by the domain of the parameter

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalHessiansIntervalTypeForward(*, forward: Literal[True] = True)

(Default) Use forward differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalHessiansIntervalTypeCentral(*, central: Literal[True] = True)

Use central differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.QuasiHessiansBfgsConfig(*, damped: Literal[True] | None = None)

Use BFGS method to compute quasi-hessians

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.QuasiHessiansSr1(*, sr1: Literal[True] = True)

Use the Symmetric Rank 1 update method to compute quasi-Hessians

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.AnalyticHessians(*, analytic_hessians: Literal[True] = True)

Hessians are needed and are available directly from the analysis driver

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.IdNumericalHessians(*, values: list[int], fd_step_size: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None)

Identify which numerical-Hessian corresponds to which response

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedHessiansRelative(*, relative: Literal[True] = True)

(Default) Scale step size by the parameter value

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedHessiansAbsolute(*, absolute: Literal[True] = True)

Do not scale step-size

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedHessiansBounds(*, bounds: Literal[True] = True)

Scale step-size by the domain of the parameter

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedHessiansIntervalTypeForward(*, forward: Literal[True] = True)

(Default) Use forward differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedHessiansIntervalTypeCentral(*, central: Literal[True] = True)

Use central differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.IdQuasiHessiansBfgsConfig(*, damped: Literal[True] | None = None)

Use BFGS method to compute quasi-hessians

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.IdQuasiHessiansSr1(*, sr1: Literal[True] = True)

Use the Symmetric Rank 1 update method to compute quasi-Hessians

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext1Probabilities(*, probabilities: Literal[True] = True)

Computes probabilities associated with response levels

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext1GenReliabilities(*, gen_reliabilities: Literal[True] = True)

Computes generalized reliabilities associated with response levels

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext1SystemSeries(*, series: Literal[True] = True)

Aggregate response statistics assuming a series system

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext1SystemParallel(*, parallel: Literal[True] = True)

Aggregate response statistics assuming a parallel system

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext2Probabilities(*, probabilities: Literal[True] = True)

Computes probabilities associated with response levels

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext2GenReliabilities(*, gen_reliabilities: Literal[True] = True)

Computes generalized reliabilities associated with response levels

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext2SystemSeries(*, series: Literal[True] = True)

Aggregate response statistics assuming a series system

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext2SystemParallel(*, parallel: Literal[True] = True)

Aggregate response statistics assuming a parallel system

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseScalarDataFormatCustomAnnotatedConfig(*, header: Literal[True] | None = None, exp_id: Literal[True] | None = None)

Selects custom-annotated tabular file format for experiment data

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseScalarDataFormatAnnotated(*, annotated: Literal[True] = True)

Selects annotated tabular file format for experiment data

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseScalarDataFormatFreeform(*, freeform: Literal[True] = True)

Selects free-form tabular file format for experiment data

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsMethodSourceDakotaConfig(*, ignore_bounds: Literal[True] | None = None, step_scaling: MixedGradientsMethodSourceDakotaRelative | MixedGradientsMethodSourceDakotaAbsolute | MixedGradientsMethodSourceDakotaBounds = <factory>)

(Default) Use internal Dakota finite differences algorithm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsMethodSourceDakotaConfig(*, ignore_bounds: Literal[True] | None = None, step_scaling: NumericalGradientsMethodSourceDakotaRelative | NumericalGradientsMethodSourceDakotaAbsolute | NumericalGradientsMethodSourceDakotaBounds = <factory>)

(Default) Use internal Dakota finite differences algorithm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalHessiansConfig(*, fd_step_size: list[~typing.Annotated[float, ~pydantic.functional_serializers.PlainSerializer(func=~dakota.spec.base._serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, step_scaling: NumericalHessiansRelative | NumericalHessiansAbsolute | NumericalHessiansBounds = <factory>, interval_type: NumericalHessiansIntervalTypeForward | NumericalHessiansIntervalTypeCentral = <factory>)

Hessians are needed and will be approximated by finite differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.QuasiHessiansBfgs(*, bfgs: QuasiHessiansBfgsConfig)

Use BFGS method to compute quasi-hessians

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.IdQuasiHessiansBfgs(*, bfgs: IdQuasiHessiansBfgsConfig)

Use BFGS method to compute quasi-hessians

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext1Compute(*, statistic: ResponseLevelsComputeProbGenContext1Probabilities | ResponseLevelsComputeProbGenContext1GenReliabilities, system: ResponseLevelsComputeProbGenContext1SystemSeries | ResponseLevelsComputeProbGenContext1SystemParallel | None = None)

Selection of statistics to compute at each response level

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext2Compute(*, statistic: ResponseLevelsComputeProbGenContext2Probabilities | ResponseLevelsComputeProbGenContext2GenReliabilities, system: ResponseLevelsComputeProbGenContext2SystemSeries | ResponseLevelsComputeProbGenContext2SystemParallel | None = None)

Selection of statistics to compute at each response level

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseScalarDataFormatCustomAnnotated(*, custom_annotated: ResponseScalarDataFormatCustomAnnotatedConfig = <factory>)

Selects custom-annotated tabular file format for experiment data

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsMethodSourceDakota(*, dakota: MixedGradientsMethodSourceDakotaConfig = <factory>)

(Default) Use internal Dakota finite differences algorithm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsMethodSourceDakota(*, dakota: NumericalGradientsMethodSourceDakotaConfig = <factory>)

(Default) Use internal Dakota finite differences algorithm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalHessians(*, numerical_hessians: NumericalHessiansConfig)

Hessians are needed and will be approximated by finite differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.QuasiHessians(*, quasi_hessians: QuasiHessiansBfgs | QuasiHessiansSr1)

Hessians are needed and will be approximated by secant updates (BFGS or SR1) from a series of gradient evaluations

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.IdQuasiHessians(*, values: list[int], approximation: IdQuasiHessiansBfgs | IdQuasiHessiansSr1)

Identify which quasi-Hessian corresponds to which response

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext1ResponseLevels(*, values: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]], num_response_levels: list[int] | None = None, compute: ResponseLevelsComputeProbGenContext1Compute | None = None)

Values at which to estimate desired statistics for each response

model_config = {'extra': 'forbid', 'json_schema_extra': <function DakotaBaseModel.__init_subclass__.<locals>.combined_schema_extra>, 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext2ResponseLevels(*, values: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]], num_response_levels: list[int] | None = None, compute: ResponseLevelsComputeProbGenContext2Compute | None = None)

Undocumented: Recursive k-d (RKD) Darts is an experimental capability.

model_config = {'extra': 'forbid', 'json_schema_extra': <function DakotaBaseModel.__init_subclass__.<locals>.combined_schema_extra>, 'protected_namespaces': (), 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True}

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseScalarDataFormatMixin(*, format: ResponseScalarDataFormatCustomAnnotated | ResponseScalarDataFormatAnnotated | ResponseScalarDataFormatFreeform = <factory>)

Generated model for ResponseScalarDataFormatMixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradientsConfig(*, id_numerical_gradients: list[int], id_analytic_gradients: list[int], method_source: ~dakota.spec.shared.responses.MixedGradientsMethodSourceDakota | ~dakota.spec.shared.responses.MixedGradientsMethodSourceVendor = <factory>, interval_type: ~dakota.spec.shared.responses.MixedGradientsIntervalTypeForward | ~dakota.spec.shared.responses.MixedGradientsIntervalTypeCentral = <factory>, fd_step_size: list[~typing.Annotated[float, ~pydantic.functional_serializers.PlainSerializer(func=~dakota.spec.base._serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None)

Gradients are needed and will be obtained from a mix of numerical and analytic sources

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradientsConfig(*, method_source: NumericalGradientsMethodSourceDakota | NumericalGradientsMethodSourceVendor = <factory>, interval_type: NumericalGradientsIntervalTypeForward | NumericalGradientsIntervalTypeCentral = <factory>, fd_step_size: list[~typing.Annotated[float, ~pydantic.functional_serializers.PlainSerializer(func=~dakota.spec.base._serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None)

Gradients are needed and will be approximated by finite differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedHessiansConfig(*, id_numerical_hessians: IdNumericalHessians | None = None, step_scaling: MixedHessiansRelative | MixedHessiansAbsolute | MixedHessiansBounds = <factory>, interval_type: MixedHessiansIntervalTypeForward | MixedHessiansIntervalTypeCentral = <factory>, id_quasi_hessians: IdQuasiHessians | None = None, id_analytic_hessians: list[int] | None = None)

Hessians are needed and will be obtained from a mix of numerical, analytic, and "quasi" sources

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext1Mixin(*, response_levels: ResponseLevelsComputeProbGenContext1ResponseLevels | None = None)

Generated model for ResponseLevelsComputeProbGenContext1Mixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseLevelsComputeProbGenContext2Mixin(*, response_levels: ResponseLevelsComputeProbGenContext2ResponseLevels | None = None)

Generated model for ResponseLevelsComputeProbGenContext2Mixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedGradients(*, mixed_gradients: MixedGradientsConfig)

Gradients are needed and will be obtained from a mix of numerical and analytic sources

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.NumericalGradients(*, numerical_gradients: NumericalGradientsConfig)

Gradients are needed and will be approximated by finite differences

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.MixedHessians(*, mixed_hessians: MixedHessiansConfig)

Hessians are needed and will be obtained from a mix of numerical, analytic, and "quasi" sources

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseGradientsMixin(*, gradient_type: NoGradients | AnalyticGradients | MixedGradients | NumericalGradients)

Generated model for ResponseGradientsMixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.responses.ResponseHessiansMixin(*, hessian_type: NoHessians | NumericalHessians | QuasiHessians | AnalyticHessians | MixedHessians)

Generated model for ResponseHessiansMixin

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

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

universal_validator()

Example universal validator that runs for all models