Core

Generated Pydantic models for shared.core

class dakota.spec.shared.core.DefaultConstraintTolMixin(*, constraint_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 0.0)

Generated model for DefaultConstraintTolMixin

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.core.MethodConvergenceTolMixin(*, convergence_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = -1.7976931348623157e+308)

Generated model for MethodConvergenceTolMixin

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.core.MethodConvergenceTolWithTypeContext1Relative(*, relative: Literal[True] = True)

Assess convergence in adaptive UQ methods using statistical metrics that are relative to a benchmark

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.core.MethodConvergenceTolWithTypeContext1Absolute(*, absolute: Literal[True] = True)

Use absolute statistical metrics for assessing convergence in adaptive UQ methods

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.core.MethodConvergenceTolWithTypeContext2Relative(*, relative: Literal[True] = True)

Assess convergence in adaptive UQ methods using statistical metrics that are relative to a benchmark

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.core.MethodConvergenceTolWithTypeContext2Absolute(*, absolute: Literal[True] = True)

Use absolute statistical metrics for assessing convergence in adaptive UQ methods

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.core.MethodConvergenceTolWithTypeContext3Relative(*, relative: Literal[True] = True)

Assess convergence in adaptive UQ methods using statistical metrics that are relative to a benchmark

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.core.MethodConvergenceTolWithTypeContext3Absolute(*, absolute: Literal[True] = True)

Use absolute statistical metrics for assessing convergence in adaptive UQ methods

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.core.Active(*, active: Literal[True] = True)

use statistics for the active expansion within multifidelity refinement

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.core.StatisticsModeCombined(*, combined: Literal[True] = True)

use statistics for the combined expansion within multifidelity refinement

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.core.LevelMappings(*, level_mappings: Literal[True] = True)

Utilize the level mappings metric for guiding adaptive refinement during UQ.

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.core.RefinementMetricCov(*, covariance: Literal[True] = True)

Utilize the response covariance metric for guiding adaptive refinement during UQ.

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.core.NumericalGradientOptionsMethodSourceDakotaRelative(*, 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.core.NumericalGradientOptionsMethodSourceDakotaAbsolute(*, 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.core.NumericalGradientOptionsMethodSourceDakotaBounds(*, 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.core.NumericalGradientOptionsMethodSourceVendor(*, 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.core.NumericalGradientOptionsIntervalTypeForward(*, 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.core.NumericalGradientOptionsIntervalTypeCentral(*, 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.core.ResponseLevelsComputeProbRelGenProbabilities(*, 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.core.ResponseLevelsComputeProbRelGenReliabilities(*, reliabilities: Literal[True] = True)

Computes 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.core.ResponseLevelsComputeProbRelGenGenReliabilities(*, 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.core.ResponseLevelsComputeProbRelGenSystemSeries(*, 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.core.ResponseLevelsComputeProbRelGenSystemParallel(*, 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.core.MethodConvergenceTolWithTypeContext1ConvergenceTol(*, value: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = -1.7976931348623157e+308, convergence_tolerance_type: MethodConvergenceTolWithTypeContext1Relative | MethodConvergenceTolWithTypeContext1Absolute | None = None)

Stopping criterion based on relative error

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.core.MethodConvergenceTolWithTypeContext2ConvergenceTol(*, value: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = -1.7976931348623157e+308, convergence_tolerance_type: MethodConvergenceTolWithTypeContext2Relative | MethodConvergenceTolWithTypeContext2Absolute | None = None)

Stopping criterion based on objective function or statistics convergence

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.core.MethodConvergenceTolWithTypeContext3ConvergenceTol(*, value: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = -1.7976931348623157e+308, convergence_tolerance_type: MethodConvergenceTolWithTypeContext3Relative | MethodConvergenceTolWithTypeContext3Absolute | None = None)

Stopping criterion based on relative error reduction

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.core.MethodMfRefineStatsModeMixin(*, statistics_mode: Active | StatisticsModeCombined | None = None)

Generated model for MethodMfRefineStatsModeMixin

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.core.MethodRefineMetricTypeMixin(*, refinement_metric: LevelMappings | RefinementMetricCov | None = None)

Generated model for MethodRefineMetricTypeMixin

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.core.NumericalGradientOptionsMethodSourceDakotaConfig(*, ignore_bounds: Literal[True] | None = None, step_scaling: NumericalGradientOptionsMethodSourceDakotaRelative | NumericalGradientOptionsMethodSourceDakotaAbsolute | NumericalGradientOptionsMethodSourceDakotaBounds = <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.core.ResponseLevelsComputeProbRelGenCompute(*, statistic: ResponseLevelsComputeProbRelGenProbabilities | ResponseLevelsComputeProbRelGenReliabilities | ResponseLevelsComputeProbRelGenGenReliabilities, system: ResponseLevelsComputeProbRelGenSystemSeries | ResponseLevelsComputeProbRelGenSystemParallel | 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.core.MethodConvergenceTolWithTypeContext1Mixin(*, convergence_tolerance: MethodConvergenceTolWithTypeContext1ConvergenceTol | None = None)

Generated model for MethodConvergenceTolWithTypeContext1Mixin

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.core.MethodConvergenceTolWithTypeContext2Mixin(*, convergence_tolerance: MethodConvergenceTolWithTypeContext2ConvergenceTol | None = None)

Generated model for MethodConvergenceTolWithTypeContext2Mixin

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.core.MethodConvergenceTolWithTypeContext3Mixin(*, convergence_tolerance: MethodConvergenceTolWithTypeContext3ConvergenceTol | None = None)

Generated model for MethodConvergenceTolWithTypeContext3Mixin

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.core.NumericalGradientOptionsMethodSourceDakota(*, dakota: NumericalGradientOptionsMethodSourceDakotaConfig = <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.core.ResponseLevelsComputeProbRelGenResponseLevels(*, values: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]], num_response_levels: list[int] | None = None, compute: ResponseLevelsComputeProbRelGenCompute | 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.core.MethodExpConvergenceToleranceMixin(*, refinement_metric: LevelMappings | RefinementMetricCov | None = None, convergence_tolerance: MethodConvergenceTolWithTypeContext2ConvergenceTol | None = None)

Generated model for MethodExpConvergenceToleranceMixin

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.core.MethodMfExpConvergenceToleranceMixin(*, refinement_metric: LevelMappings | RefinementMetricCov | None = None, statistics_mode: Active | StatisticsModeCombined | None = None, convergence_tolerance: MethodConvergenceTolWithTypeContext2ConvergenceTol | None = None)

Generated model for MethodMfExpConvergenceToleranceMixin

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.core.NumericalGradientOptionsMixin(*, method_source: NumericalGradientOptionsMethodSourceDakota | NumericalGradientOptionsMethodSourceVendor = <factory>, interval_type: NumericalGradientOptionsIntervalTypeForward | NumericalGradientOptionsIntervalTypeCentral = <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)

Generated model for NumericalGradientOptionsMixin

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.core.ResponseLevelsComputeProbRelGenMixin(*, response_levels: ResponseLevelsComputeProbRelGenResponseLevels | None = None)

Generated model for ResponseLevelsComputeProbRelGenMixin

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