Sampling

Generated Pydantic models for shared.sampling

class dakota.spec.shared.sampling.MlmfPilotSamplesContext1Mixin(*, pilot_samples: list[int] | None = None)

Generated model for MlmfPilotSamplesContext1Mixin

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.sampling.MlmfPilotSamplesContext2Mixin(*, pilot_samples: list[int] | None = None)

Generated model for MlmfPilotSamplesContext2Mixin

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.sampling.SamplesOnEmulatorWithAliasMixin(*, samples_on_emulator: int = 0)

Generated model for SamplesOnEmulatorWithAliasMixin

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.sampling.MethodExportSamplesFormatCustomAnnotatedConfig(*, header: Literal[True] | None = None, eval_id: Literal[True] | None = None, interface_id: Literal[True] | None = None)

Selects custom-annotated tabular file format

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.sampling.MethodExportSamplesFormatAnnotated(*, annotated: Literal[True] = True)

Selects annotated tabular file format

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.sampling.MethodExportSamplesFormatFreeform(*, freeform: Literal[True] = True)

Selects freeform file format

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.sampling.MethodSampleTypeLhsMcLhs(*, lhs: Literal[True] = True)

Uses Latin Hypercube Sampling (LHS) to sample variables

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.sampling.MethodSampleTypeLhsMcRandom(*, random: Literal[True] = True)

Uses purely random Monte Carlo sampling to sample variables

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.sampling.Fallback(*, fallback: Literal[True] = True)

Fall back to a numerical solve when needed for mitigation in MFMC

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.sampling.Override(*, override: Literal[True] = True)

Replace MFMC analytic allocation with a numerical solution

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.sampling.AutoReorder(*, auto_reorder: Literal[True] = True)

Reorder models automatically

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.sampling.FixedOrder(*, fixed_order: Literal[True] = True)

Used a fixed model order

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.sampling.NumericalSolveSqp(*, sqp: Literal[True] = True)

Use a sequential quadratic programming method for solving an optimization sub-problem

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.sampling.NumericalSolveNip(*, nip: Literal[True] = True)

Use a nonlinear interior point method for solving an optimization sub-problem

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.sampling.NumericalSolveGlobalLocal(*, global_local: Literal[True] = True)

Use a hybrid global-local scheme for solving an optimization sub-problem

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.sampling.NumericalSolveCompetedLocal(*, competed_local: Literal[True] = True)

Use a competed local solver scheme for solving an optimization sub-problem

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.sampling.NumericalSolveSolverMetricAverageEstimatorVariance(*, average_estimator_variance: Literal[True] = True)

Utilize the estimator variance averaged over the QoI as the solver metric for sampling-based multifidelity 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.sampling.NumericalSolveSolverMetricNormEstimatorVarianceConfig(*, norm_order: Annotated[float, Ge(ge=1.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 2.0)

Utilize a p-norm over the vector of QoI estimator variances as the solver metric for sampling-based multifidelity 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.sampling.NumericalSolveSolverMetricMaxEstimatorVariance(*, max_estimator_variance: Literal[True] = True)

Utilize the maximum estimator variance as the solver metric for sampling-based multifidelity 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.sampling.PilotSamples(*, counts: list[int], independent: Literal[True] | None = None)

Initial set of samples for groups in the multilevel BLUE sampling method

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.sampling.MethodExportSamplesFormatCustomAnnotated(*, custom_annotated: MethodExportSamplesFormatCustomAnnotatedConfig = <factory>)

Selects custom-annotated tabular file format

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.sampling.MethodSampleTypeLhsMcMixin(*, sample_type: MethodSampleTypeLhsMcLhs | MethodSampleTypeLhsMcRandom | None = None)

Generated model for MethodSampleTypeLhsMcMixin

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.sampling.NumericalSolveSolverMetricNormEstimatorVariance(*, norm_estimator_variance: NumericalSolveSolverMetricNormEstimatorVarianceConfig)

Utilize a p-norm over the vector of QoI estimator variances as the solver metric for sampling-based multifidelity 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.sampling.MlmfGroupPilotSamplesMixin(*, pilot_samples: PilotSamples | None = None)

Generated model for MlmfGroupPilotSamplesMixin

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.sampling.MethodExportSamplesFormatMixin(*, format: MethodExportSamplesFormatCustomAnnotated | MethodExportSamplesFormatAnnotated | MethodExportSamplesFormatFreeform = <factory>)

Generated model for MethodExportSamplesFormatMixin

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.sampling.NumericalSolve(*, numerical_solve_strategy: Fallback | Override = <factory>, model_reordering: AutoReorder | FixedOrder = <factory>, optimization_solver: NumericalSolveSqp | NumericalSolveNip | NumericalSolveGlobalLocal | NumericalSolveCompetedLocal | None = None, solver_metric: NumericalSolveSolverMetricAverageEstimatorVariance | NumericalSolveSolverMetricNormEstimatorVariance | NumericalSolveSolverMetricMaxEstimatorVariance | None = None)

Specify the situations where numerical optimization is used for MFMC sample allocation

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.sampling.MfmcNumericalSolveMixin(*, numerical_solve: NumericalSolve | None = None)

Generated model for MfmcNumericalSolveMixin

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