Bayesian

Generated Pydantic models for shared.bayesian

class dakota.spec.shared.bayesian.EmulatorGPSurfpack(*, surfpack: Literal[True] = True)

Use the Surfpack version of Gaussian Process surrogates

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.bayesian.EmulatorGPDakota(*, dakota: Literal[True] = True)

Select the built in Gaussian Process surrogate

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.bayesian.GPImportBuildPointsFileCustomAnnotatedConfig(*, 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.bayesian.GPImportBuildPointsFileAnnotated(*, 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.bayesian.GPImportBuildPointsFileFreeform(*, 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.bayesian.EmulatorPcePRefinementUniform(*, uniform: Literal[True] = True)

Refine an expansion uniformly in all dimensions.

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.bayesian.EmulatorPcePRefinementDimAdaptiveSobol(*, sobol: Literal[True] = True)

Estimate dimension preference for automated refinement of stochastic expansion using total Sobol’ sensitivity indices.

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.bayesian.EmulatorPcePRefinementDimAdaptiveDecay(*, decay: Literal[True] = True)

Estimate spectral coefficient decay rates to guide dimension-adaptive 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.bayesian.EmulatorPcePRefinementDimAdaptiveGeneralized(*, generalized: Literal[True] = True)

Use the generalized sparse grid dimension adaptive algorithm to refine a sparse grid approximation of stochastic expansion.

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.bayesian.EmulatorPceQuadratureOrderNested(*, nested: Literal[True] = True)

Enforce use of nested quadrature rules if available

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.bayesian.EmulatorPceQuadratureOrderNonNested(*, non_nested: Literal[True] = True)

Enforce use of non-nested quadrature rules

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.bayesian.EmulatorPceSGLevelRestricted(*, restricted: Literal[True] = True)

Restrict the growth rates for nested and non-nested rules can be synchronized for consistency.

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.bayesian.EmulatorPceSGLevelUnrestricted(*, unrestricted: Literal[True] = True)

Overide the default restriction of growth rates for nested and non-nested rules that are by defualt synchronized for consistency.

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.bayesian.EmulatorPceCubatureIntegrand(*, cubature_integrand: int)

Cubature using Stroud rules and their extensions

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.bayesian.EmulatorPceExpansionOrderBasisTypeTensorProduct(*, tensor_product: Literal[True] = True)

Use a tensor-product index set to construct a polynomial chaos expansion.

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.bayesian.EmulatorPceExpansionOrderBasisTypeTotalOrder(*, total_order: Literal[True] = True)

Use a total-order index set to construct a polynomial chaos expansion.

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.bayesian.EmulatorPceExpansionOrderBasisTypeAdaptedConfig(*, advancements: int = 3, soft_convergence_limit: int = 0)

Use adaptive basis selection to choose the basis terms in a polynomial chaos expansion.

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.bayesian.EmulatorPceExpansionOrderCollocPointsLeastSquaresSvd(*, svd: Literal[True] = True)

Calculate the coefficients of a polynomial chaos expansion using the singular value decomposition.

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.bayesian.EmulatorPceExpansionOrderCollocPointsLeastSquaresEqCon(*, equality_constrained: Literal[True] = True)

Calculate the coefficients of a polynomial chaos expansion using equality constrained least squares.

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.bayesian.EmulatorPceExpansionOrderCollocPointsOMPConfig(*, noise_tolerance: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None)

Compute the coefficients of a polynomial expansion using orthogonal matching pursuit (OMP)

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.bayesian.EmulatorPceExpansionOrderCollocPointsBP(*, basis_pursuit: Literal[True] = True)

Compute the coefficients of a polynomial expansion by solving the Basis Pursuit L1 -minimization problem using linear programming.

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.bayesian.EmulatorPceExpansionOrderCollocPointsLassoConfig(*, noise_tolerance: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, l2_penalty: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] | None = None)

Compute the coefficients of a polynomial expansion by using the LASSO 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.bayesian.EmulatorPceExpansionOrderCollocPointsCV(*, noise_only: Literal[True] | None = None, max_cv_order_candidates: Annotated[int, Ge(ge=0)] = 65535)

Use cross validation to choose the ‘best’ polynomial order of a polynomial chaos expansion.

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.bayesian.EmulatorPceExpansionOrderExpansionSamplesConfig(*, value: int = 9223372036854775807, reuse_points: Literal[True] | None = None)

Number of simulation samples used to estimate the expected value of a set of PCE coefficients

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.bayesian.EmulatorPceImportExpansionFile(*, import_expansion_file: str)

Build a Polynomial Chaos Expansion (PCE) by importing expansion coefficients and a corresponding multi-index from a file

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.bayesian.EmulatorPceAskey(*, askey: Literal[True] = True)

Select the standardized random variables (and associated basis polynomials) from the Askey family that best match the user-specified random 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.bayesian.EmulatorPceWiener(*, wiener: Literal[True] = True)

Use standard normal random variables (along with Hermite orthogonal basis polynomials) when transforming to a standardized probability space.

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.bayesian.EmulatorPceDiagCov(*, diagonal_covariance: Literal[True] = True)

Display only the diagonal terms of the covariance matrix

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.bayesian.EmulatorPceFullCov(*, full_covariance: Literal[True] = True)

Display the full covariance matrix

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.bayesian.EmulatorMlPceAllocationControlEstimatorVarianceConfig(*, estimator_rate: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 2.0)

Variance of mean estimator within multilevel polynomial chaos

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.bayesian.EmulatorMlPceAllocationControlRipSampling(*, rip_sampling: Literal[True] = True)

Sample allocation based on restricted isometry property (RIP) within multilevel polynomial chaos

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.bayesian.EmulatorMlPceDiscrepancyEmulationDistinct(*, distinct: Literal[True] = True)

Distinct formulation for emulation of model discrepancies.

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.bayesian.EmulatorMlPceDiscrepancyEmulationRecursive(*, recursive: Literal[True] = True)

Recursive formulation for emulation of model discrepancies.

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.bayesian.EmulatorMlPceExpansionOrderSequenceExpansionSamplesSequenceConfig(*, sequence: list[int], reuse_points: Literal[True] | None = None)

Sequence of expansion samples used in a multi-stage polynomial chaos expansion Each level entry of the expansion_samples_sequence applies to one expansion within a multi-stage expansion. Current multi-stage expansions that support expansion samples sequences include multilevel and multifidelity polynomial chaos. If adaptive refinement is active, then this sequence specifies the starting point for each level within either an individual or integrated refinement approach. A corresponding scalar specification is documented at, e.g., expansion_samples

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.bayesian.EmulatorMfPceAllocationControlGreedy(*, greedy: Literal[True] = True)

Sample allocation based on greedy refinement within multifidelity polynomial chaos

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.bayesian.EmulatorScHRefinementLocalAdaptive(*, local_adaptive: Literal[True] = True)

Planned future capability for local pointwise refinement within a generalized sparse grid.

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.bayesian.EmulatorScSGLevelNodal(*, nodal: Literal[True] = True)

Employ a nodal sparse grid construction in stochastic collocation

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.bayesian.EmulatorScSGLevelHierarchical(*, hierarchical: Literal[True] = True)

Employ a hierarchical sparse grid construction

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.bayesian.EmulatorScPiecewise(*, piecewise: Literal[True] = True)

Use piecewise local basis functions

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.bayesian.MfScPRefinementUniform(*, uniform: Literal[True] = True)

Refine an expansion uniformly in all dimensions.

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.bayesian.MfScPRefinementDimAdaptiveSobol(*, sobol: Literal[True] = True)

Estimate dimension preference for automated refinement of stochastic expansion using total Sobol’ sensitivity indices.

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.bayesian.MfScPRefinementDimAdaptiveGeneralized(*, generalized: Literal[True] = True)

Use the generalized sparse grid dimension adaptive algorithm to refine a sparse grid approximation of stochastic expansion.

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.bayesian.MfScHRefinementLocalAdaptive(*, local_adaptive: Literal[True] = True)

Planned future capability for local pointwise refinement within a generalized sparse grid.

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.bayesian.MfScAllocationControlGreedy(*, greedy: Literal[True] = True)

Sample allocation based on greedy refinement within multifidelity stochastic collocation

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.bayesian.MfScDiscrepancyEmulationDistinct(*, distinct: Literal[True] = True)

Distinct formulation for emulation of model discrepancies.

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.bayesian.MfScDiscrepancyEmulationRecursive(*, recursive: Literal[True] = True)

Recursive formulation for emulation of model discrepancies.

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.bayesian.MfScQuadratureOrderSequenceNested(*, nested: Literal[True] = True)

Enforce use of nested quadrature rules if available

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.bayesian.MfScQuadratureOrderSequenceNonNested(*, non_nested: Literal[True] = True)

Enforce use of non-nested quadrature rules

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.bayesian.MfScSGLevelSequenceNodal(*, nodal: Literal[True] = True)

Employ a nodal sparse grid construction in stochastic collocation

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.bayesian.MfScSGLevelSequenceHierarchical(*, hierarchical: Literal[True] = True)

Employ a hierarchical sparse grid construction

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.bayesian.MfScSGLevelSequenceRestricted(*, restricted: Literal[True] = True)

Restrict the growth rates for nested and non-nested rules can be synchronized for consistency.

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.bayesian.MfScSGLevelSequenceUnrestricted(*, unrestricted: Literal[True] = True)

Overide the default restriction of growth rates for nested and non-nested rules that are by defualt synchronized for consistency.

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.bayesian.MfScPiecewise(*, piecewise: Literal[True] = True)

Use piecewise local basis functions

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.bayesian.MfScAskey(*, askey: Literal[True] = True)

Select the standardized random variables (and associated basis polynomials) from the Askey family that best match the user-specified random 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.bayesian.MfScWiener(*, wiener: Literal[True] = True)

Use standard normal random variables (along with Hermite orthogonal basis polynomials) when transforming to a standardized probability space.

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.bayesian.MfScDiagCov(*, diagonal_covariance: Literal[True] = True)

Display only the diagonal terms of the covariance matrix

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.bayesian.MfScFullCov(*, full_covariance: Literal[True] = True)

Display the full covariance matrix

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.bayesian.PriorConfig(*, multiplier: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1.0)

Uses the covariance of the prior distributions to define the MCMC proposal covariance.

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.bayesian.DerivativesConfig(*, update_period: int = 2147483647)

Use derivatives to inform the MCMC proposal covariance.

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.bayesian.ValuesDiag(*, diagonal: Literal[True] = True)

Specifies the diagonal matrix format when specifying a user-specified proposal covariance.

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.bayesian.ValuesMatrix(*, matrix: Literal[True] = True)

Specifies the full matrix format when specifying a user-specified proposal covariance.

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.bayesian.ScPRefinementUniform(*, uniform: Literal[True] = True)

Refine an expansion uniformly in all dimensions.

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.bayesian.ScPRefinementDimAdaptiveSobol(*, sobol: Literal[True] = True)

Estimate dimension preference for automated refinement of stochastic expansion using total Sobol’ sensitivity indices.

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.bayesian.ScPRefinementDimAdaptiveGeneralized(*, generalized: Literal[True] = True)

Use the generalized sparse grid dimension adaptive algorithm to refine a sparse grid approximation of stochastic expansion.

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.bayesian.BayesScHRefinementLocalAdaptive(*, local_adaptive: Literal[True] = True)

Planned future capability for local pointwise refinement within a generalized sparse grid.

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.bayesian.ScQuadratureOrderNested(*, nested: Literal[True] = True)

Enforce use of nested quadrature rules if available

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.bayesian.ScQuadratureOrderNonNested(*, non_nested: Literal[True] = True)

Enforce use of non-nested quadrature rules

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.bayesian.BayesScSGLevelNodal(*, nodal: Literal[True] = True)

Employ a nodal sparse grid construction in stochastic collocation

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.bayesian.BayesScSGLevelHierarchical(*, hierarchical: Literal[True] = True)

Employ a hierarchical sparse grid construction

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.bayesian.BayesScSGLevelRestricted(*, restricted: Literal[True] = True)

Restrict the growth rates for nested and non-nested rules can be synchronized for consistency.

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.bayesian.BayesScSGLevelUnrestricted(*, unrestricted: Literal[True] = True)

Overide the default restriction of growth rates for nested and non-nested rules that are by defualt synchronized for consistency.

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.bayesian.BayesScPiecewise(*, piecewise: Literal[True] = True)

Use piecewise local basis functions

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.bayesian.ScAskey(*, askey: Literal[True] = True)

Select the standardized random variables (and associated basis polynomials) from the Askey family that best match the user-specified random 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.bayesian.ScWiener(*, wiener: Literal[True] = True)

Use standard normal random variables (along with Hermite orthogonal basis polynomials) when transforming to a standardized probability space.

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.bayesian.ScDiagCov(*, diagonal_covariance: Literal[True] = True)

Display only the diagonal terms of the covariance matrix

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.bayesian.ScFullCov(*, full_covariance: Literal[True] = True)

Display the full covariance matrix

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.bayesian.BayesSeedRngMt19937(*, mt19937: Literal[True] = True)

Generates random numbers using the Mersenne twister

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.bayesian.BayesSeedRngRnum2(*, rnum2: Literal[True] = True)

Generates pseudo-random numbers using the Pecos package

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.bayesian.GPImportBuildPointsFileCustomAnnotated(*, custom_annotated: GPImportBuildPointsFileCustomAnnotatedConfig = <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.bayesian.EmulatorPceExpansionOrderImportBuildPointsFileCustomAnnotated(*, custom_annotated: GPImportBuildPointsFileCustomAnnotatedConfig = <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.bayesian.EmulatorPcePRefinementDimAdaptive(*, dimension_adaptive: EmulatorPcePRefinementDimAdaptiveSobol | EmulatorPcePRefinementDimAdaptiveDecay | EmulatorPcePRefinementDimAdaptiveGeneralized)

Perform anisotropic expansion refinement by preferentially adapting in dimensions that are detected to have higher "importance".

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.bayesian.EmulatorMfPcePRefinementDimAdaptive(*, dimension_adaptive: EmulatorPcePRefinementDimAdaptiveSobol | EmulatorPcePRefinementDimAdaptiveDecay | EmulatorPcePRefinementDimAdaptiveGeneralized)

Perform anisotropic expansion refinement by preferentially adapting in dimensions that are detected to have higher "importance".

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.bayesian.EmulatorScPRefinementDimAdaptive(*, dimension_adaptive: EmulatorPcePRefinementDimAdaptiveSobol | EmulatorPcePRefinementDimAdaptiveGeneralized)

Perform anisotropic expansion refinement by preferentially adapting in dimensions that are detected to have higher "importance".

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.bayesian.EmulatorPceQuadratureOrderConfig(*, order: int = 65535, dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, nesting_rule: EmulatorPceQuadratureOrderNested | EmulatorPceQuadratureOrderNonNested | None = None)

Order for tensor-products of Gaussian quadrature rules

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.bayesian.EmulatorMfPceQuadratureOrderSequenceConfig(*, sequence: list[int], dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, nesting_rule: EmulatorPceQuadratureOrderNested | EmulatorPceQuadratureOrderNonNested | None = None)

Sequence of quadrature orders used in a multi-stage expansion

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.bayesian.EmulatorScQuadratureOrderConfig(*, order: int = 65535, dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, nesting_rule: EmulatorPceQuadratureOrderNested | EmulatorPceQuadratureOrderNonNested | None = None)

Order for tensor-products of Gaussian quadrature rules

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.bayesian.EmulatorPceSGLevelConfig(*, level: int = 65535, dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, growth_rule: EmulatorPceSGLevelRestricted | EmulatorPceSGLevelUnrestricted | None = None, nesting_rule: EmulatorPceQuadratureOrderNested | EmulatorPceQuadratureOrderNonNested | None = None)

Level to use in sparse grid integration or interpolation

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.bayesian.EmulatorMfPceSGLevelSequenceConfig(*, sequence: list[int], dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, growth_rule: EmulatorPceSGLevelRestricted | EmulatorPceSGLevelUnrestricted | None = None, nesting_rule: EmulatorPceQuadratureOrderNested | EmulatorPceQuadratureOrderNonNested | None = None)

Sequence of sparse grid levels used in a multi-stage expansion

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.bayesian.EmulatorPceExpansionOrderBasisTypeAdapted(*, adapted: EmulatorPceExpansionOrderBasisTypeAdaptedConfig)

Use adaptive basis selection to choose the basis terms in a polynomial chaos expansion.

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.bayesian.EmulatorMlPceExpansionOrderSequenceBasisTypeAdapted(*, adapted: EmulatorPceExpansionOrderBasisTypeAdaptedConfig)

Use adaptive basis selection to choose the basis terms in a polynomial chaos expansion.

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.bayesian.EmulatorPceExpansionOrderCollocPointsLeastSquares(*, least_squares: EmulatorPceExpansionOrderCollocPointsLeastSquaresSvd | EmulatorPceExpansionOrderCollocPointsLeastSquaresEqCon | dict)

Compute the coefficients of a polynomial expansion using least squares

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.bayesian.EmulatorPceExpansionOrderCollocRatioLeastSquares(*, least_squares: EmulatorPceExpansionOrderCollocPointsLeastSquaresSvd | EmulatorPceExpansionOrderCollocPointsLeastSquaresEqCon | dict)

Compute the coefficients of a polynomial expansion using least squares

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.bayesian.EmulatorPceExpansionOrderCollocPointsOMP(*, orthogonal_matching_pursuit: EmulatorPceExpansionOrderCollocPointsOMPConfig)

Compute the coefficients of a polynomial expansion using orthogonal matching pursuit (OMP)

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.bayesian.EmulatorPceExpansionOrderCollocPointsBPDN(*, basis_pursuit_denoising: EmulatorPceExpansionOrderCollocPointsOMPConfig)

Compute the coefficients of a polynomial expansion by solving the Basis Pursuit Denoising L1 -minimization problem using second order cone optimization.

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.bayesian.EmulatorPceExpansionOrderCollocPointsLars(*, least_angle_regression: EmulatorPceExpansionOrderCollocPointsOMPConfig)

Compute the coefficients of a polynomial expansion by using the greedy least angle regression (LAR) method.

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.bayesian.EmulatorPceExpansionOrderCollocRatioOMP(*, orthogonal_matching_pursuit: EmulatorPceExpansionOrderCollocPointsOMPConfig)

Compute the coefficients of a polynomial expansion using orthogonal matching pursuit (OMP)

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.bayesian.EmulatorPceExpansionOrderCollocPointsLasso(*, least_absolute_shrinkage: EmulatorPceExpansionOrderCollocPointsLassoConfig)

Compute the coefficients of a polynomial expansion by using the LASSO 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.bayesian.EmulatorPceExpansionOrderCollocRatioLasso(*, least_absolute_shrinkage: EmulatorPceExpansionOrderCollocPointsLassoConfig)

Compute the coefficients of a polynomial expansion by using the LASSO 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.bayesian.EmulatorPceExpansionOrderExpansionSamples(*, expansion_samples: EmulatorPceExpansionOrderExpansionSamplesConfig)

Number of simulation samples used to estimate the expected value of a set of PCE coefficients

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.bayesian.EmulatorMlPceAllocationControlEstimatorVariance(*, estimator_variance: EmulatorMlPceAllocationControlEstimatorVarianceConfig)

Variance of mean estimator within multilevel polynomial chaos

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.bayesian.EmulatorMlPceExpansionOrderSequenceExpansionSamplesSequence(*, expansion_samples_sequence: EmulatorMlPceExpansionOrderSequenceExpansionSamplesSequenceConfig)

Sequence of expansion samples used in a multi-stage polynomial chaos expansion Each level entry of the expansion_samples_sequence applies to one expansion within a multi-stage expansion. Current multi-stage expansions that support expansion samples sequences include multilevel and multifidelity polynomial chaos. If adaptive refinement is active, then this sequence specifies the starting point for each level within either an individual or integrated refinement approach. A corresponding scalar specification is documented at, e.g., expansion_samples

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.bayesian.EmulatorMfPceExpansionOrderSequenceExpansionSamplesSequence(*, expansion_samples_sequence: EmulatorMlPceExpansionOrderSequenceExpansionSamplesSequenceConfig)

Sequence of expansion samples used in a multi-stage polynomial chaos expansion Each level entry of the expansion_samples_sequence applies to one expansion within a multi-stage expansion. Current multi-stage expansions that support expansion samples sequences include multilevel and multifidelity polynomial chaos. If adaptive refinement is active, then this sequence specifies the starting point for each level within either an individual or integrated refinement approach. A corresponding scalar specification is documented at, e.g., expansion_samples

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.bayesian.EmulatorScSGLevelConfig(*, level: int = 65535, dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, interpolant: EmulatorScSGLevelNodal | EmulatorScSGLevelHierarchical | None = None, growth_rule: EmulatorPceSGLevelRestricted | EmulatorPceSGLevelUnrestricted | None = None, nesting_rule: EmulatorPceQuadratureOrderNested | EmulatorPceQuadratureOrderNonNested | None = None)

Level to use in sparse grid integration or interpolation

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.bayesian.EmulatorMfScSGLevelSequenceConfig(*, sequence: list[int], dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, interpolant: EmulatorScSGLevelNodal | EmulatorScSGLevelHierarchical | None = None, growth_rule: EmulatorPceSGLevelRestricted | EmulatorPceSGLevelUnrestricted | None = None, nesting_rule: EmulatorPceQuadratureOrderNested | EmulatorPceQuadratureOrderNonNested | None = None)

Sequence of sparse grid levels used in a multi-stage expansion

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.bayesian.MfScPRefinementDimAdaptive(*, dimension_adaptive: MfScPRefinementDimAdaptiveSobol | MfScPRefinementDimAdaptiveGeneralized)

Perform anisotropic expansion refinement by preferentially adapting in dimensions that are detected to have higher "importance".

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.bayesian.MfScHRefinementDimAdaptive(*, dimension_adaptive: MfScPRefinementDimAdaptiveSobol | MfScPRefinementDimAdaptiveGeneralized)

Perform anisotropic expansion refinement by preferentially adapting in dimensions that are detected to have higher "importance".

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.bayesian.MfScQuadratureOrderSequenceConfig(*, sequence: list[int], dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, nesting_rule: MfScQuadratureOrderSequenceNested | MfScQuadratureOrderSequenceNonNested | None = None)

Sequence of quadrature orders used in a multi-stage expansion

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.bayesian.BayesMfScSGLevelSequenceConfig(*, sequence: list[int], dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, interpolant: MfScSGLevelSequenceNodal | MfScSGLevelSequenceHierarchical | None = None, growth_rule: MfScSGLevelSequenceRestricted | MfScSGLevelSequenceUnrestricted | None = None, nesting_rule: MfScQuadratureOrderSequenceNested | MfScQuadratureOrderSequenceNonNested | None = None)

Sequence of sparse grid levels used in a multi-stage expansion

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.bayesian.Prior(*, prior: PriorConfig)

Uses the covariance of the prior distributions to define the MCMC proposal covariance.

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.bayesian.Derivatives(*, derivatives: DerivativesConfig)

Use derivatives to inform the MCMC proposal covariance.

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.bayesian.ValuesConfig(*, elements: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]], covariance_form: ValuesDiag | ValuesMatrix)

Specifies matrix values to use as the MCMC proposal covariance.

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.bayesian.FileConfig(*, filename: str, covariance_form: ValuesDiag | ValuesMatrix)

Uses a file to import a user-specified MCMC proposal covariance.

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.bayesian.BayesScPRefinementDimAdaptive(*, dimension_adaptive: ScPRefinementDimAdaptiveSobol | ScPRefinementDimAdaptiveGeneralized)

Perform anisotropic expansion refinement by preferentially adapting in dimensions that are detected to have higher "importance".

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.bayesian.ScHRefinementDimAdaptive(*, dimension_adaptive: ScPRefinementDimAdaptiveSobol | ScPRefinementDimAdaptiveGeneralized)

Perform anisotropic expansion refinement by preferentially adapting in dimensions that are detected to have higher "importance".

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.bayesian.BayesScQuadratureOrderConfig(*, order: int = 65535, dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, nesting_rule: ScQuadratureOrderNested | ScQuadratureOrderNonNested | None = None)

Order for tensor-products of Gaussian quadrature rules

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.bayesian.BayesScSGLevelConfig(*, level: int = 65535, dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, interpolant: BayesScSGLevelNodal | BayesScSGLevelHierarchical | None = None, growth_rule: BayesScSGLevelRestricted | BayesScSGLevelUnrestricted | None = None, nesting_rule: ScQuadratureOrderNested | ScQuadratureOrderNonNested | None = None)

Level to use in sparse grid integration or interpolation

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.bayesian.BayesSeedRngMixin(*, seed: Annotated[int | None, ~annotated_types.Gt(gt=0)] = None, rng: BayesSeedRngMt19937 | BayesSeedRngRnum2 = <factory>)

Generated model for BayesSeedRngMixin

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.bayesian.GPImportBuildPointsFile(*, filename: str, format: GPImportBuildPointsFileCustomAnnotated | GPImportBuildPointsFileAnnotated | GPImportBuildPointsFileFreeform = <factory>, active_only: Literal[True] | None = None)

File containing points you wish to use to build a surrogate

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.bayesian.EmulatorPceExpansionOrderImportBuildPointsFile(*, filename: str, format: EmulatorPceExpansionOrderImportBuildPointsFileCustomAnnotated | GPImportBuildPointsFileAnnotated | GPImportBuildPointsFileFreeform = <factory>, active_only: Literal[True] | None = None)

File containing points you wish to use to build a surrogate

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.bayesian.EmulatorPceOrthogLeastInterpImportBuildPointsFile(*, filename: str, format: EmulatorPceExpansionOrderImportBuildPointsFileCustomAnnotated | GPImportBuildPointsFileAnnotated | GPImportBuildPointsFileFreeform = <factory>, active_only: Literal[True] | None = None)

File containing points you wish to use to build a surrogate

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.bayesian.EmulatorScPRefinement(*, p_refinement: EmulatorPcePRefinementUniform | EmulatorScPRefinementDimAdaptive)

Automatic polynomial order 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.bayesian.EmulatorScHRefinement(*, h_refinement: EmulatorPcePRefinementUniform | EmulatorScPRefinementDimAdaptive | EmulatorScHRefinementLocalAdaptive)

Employ h-refinement to refine the grid

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.bayesian.EmulatorMfScPRefinement(*, p_refinement: EmulatorPcePRefinementUniform | EmulatorScPRefinementDimAdaptive)

Automatic polynomial order 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.bayesian.EmulatorMfScHRefinement(*, h_refinement: EmulatorPcePRefinementUniform | EmulatorScPRefinementDimAdaptive | EmulatorScHRefinementLocalAdaptive)

Employ h-refinement to refine the grid

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.bayesian.EmulatorPceQuadratureOrder(*, quadrature_order: EmulatorPceQuadratureOrderConfig)

Order for tensor-products of Gaussian quadrature rules

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.bayesian.EmulatorMfPceQuadratureOrderSequence(*, quadrature_order_sequence: EmulatorMfPceQuadratureOrderSequenceConfig)

Sequence of quadrature orders used in a multi-stage expansion

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.bayesian.EmulatorMfScQuadratureOrderSequence(*, quadrature_order_sequence: EmulatorMfPceQuadratureOrderSequenceConfig)

Sequence of quadrature orders used in a multi-stage expansion

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.bayesian.EmulatorScQuadratureOrder(*, quadrature_order: EmulatorScQuadratureOrderConfig)

Order for tensor-products of Gaussian quadrature rules

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.bayesian.EmulatorPceSGLevel(*, sparse_grid_level: EmulatorPceSGLevelConfig)

Level to use in sparse grid integration or interpolation

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.bayesian.EmulatorMfPceSGLevelSequence(*, sparse_grid_level_sequence: EmulatorMfPceSGLevelSequenceConfig)

Sequence of sparse grid levels used in a multi-stage expansion

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.bayesian.EmulatorPceExpansionOrderCollocPointsConfig(*, points: int, regression_method: EmulatorPceExpansionOrderCollocPointsLeastSquares | EmulatorPceExpansionOrderCollocPointsOMP | EmulatorPceExpansionOrderCollocPointsBP | EmulatorPceExpansionOrderCollocPointsBPDN | EmulatorPceExpansionOrderCollocPointsLars | EmulatorPceExpansionOrderCollocPointsLasso | None = None, cross_validation: EmulatorPceExpansionOrderCollocPointsCV | None = None, ratio_order: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1.0, response_scaling: Literal[True] | None = None, use_derivatives: Literal[True] | None = None, tensor_grid: Literal[True] | None = None, reuse_points: Literal[True] | None = None, max_solver_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807)

Number of collocation points used to estimate expansion coefficients

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.bayesian.EmulatorPceExpansionOrderCollocRatioConfig(*, value: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)], regression_method: EmulatorPceExpansionOrderCollocRatioLeastSquares | EmulatorPceExpansionOrderCollocRatioOMP | EmulatorPceExpansionOrderCollocPointsBP | EmulatorPceExpansionOrderCollocPointsBPDN | EmulatorPceExpansionOrderCollocPointsLars | EmulatorPceExpansionOrderCollocRatioLasso | None = None, cross_validation: EmulatorPceExpansionOrderCollocPointsCV | None = None, ratio_order: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1.0, response_scaling: Literal[True] | None = None, use_derivatives: Literal[True] | None = None, tensor_grid: Literal[True] | None = None, reuse_points: Literal[True] | None = None, max_solver_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807)

Set the number of points used to build a PCE via regression to be proportional to the number of terms in the expansion.

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.bayesian.EmulatorMlPceExpansionOrderSequenceCollocRatioConfig(*, sequence: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)], collocation_points_sequence: list[int] | None = None, regression_method: EmulatorPceExpansionOrderCollocRatioLeastSquares | EmulatorPceExpansionOrderCollocRatioOMP | EmulatorPceExpansionOrderCollocPointsBP | EmulatorPceExpansionOrderCollocPointsBPDN | EmulatorPceExpansionOrderCollocPointsLars | EmulatorPceExpansionOrderCollocRatioLasso | None = None, cross_validation: EmulatorPceExpansionOrderCollocPointsCV | None = None, ratio_order: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1.0, response_scaling: Literal[True] | None = None, use_derivatives: Literal[True] | None = None, tensor_grid: Literal[True] | None = None, reuse_points: Literal[True] | None = None, max_solver_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807)

Set the number of points used to build a PCE via regression to be proportional to the number of terms in the expansion.

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.bayesian.EmulatorMfPceExpansionOrderSequenceCollocRatioConfig(*, sequence: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)], collocation_points_sequence: list[int] | None = None, regression_method: EmulatorPceExpansionOrderCollocRatioLeastSquares | EmulatorPceExpansionOrderCollocRatioOMP | EmulatorPceExpansionOrderCollocPointsBP | EmulatorPceExpansionOrderCollocPointsBPDN | EmulatorPceExpansionOrderCollocPointsLars | EmulatorPceExpansionOrderCollocRatioLasso | None = None, cross_validation: EmulatorPceExpansionOrderCollocPointsCV | None = None, ratio_order: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1.0, response_scaling: Literal[True] | None = None, use_derivatives: Literal[True] | None = None, tensor_grid: Literal[True] | None = None, reuse_points: Literal[True] | None = None, max_solver_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807)

Set the number of points used to build a PCE via regression to be proportional to the number of terms in the expansion.

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.bayesian.EmulatorScSGLevel(*, sparse_grid_level: EmulatorScSGLevelConfig)

Level to use in sparse grid integration or interpolation

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.bayesian.EmulatorMfScSGLevelSequence(*, sparse_grid_level_sequence: EmulatorMfScSGLevelSequenceConfig)

Sequence of sparse grid levels used in a multi-stage expansion

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.bayesian.BayesMfScPRefinement(*, p_refinement: MfScPRefinementUniform | MfScPRefinementDimAdaptive)

Automatic polynomial order 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.bayesian.BayesMfScHRefinement(*, h_refinement: MfScPRefinementUniform | MfScHRefinementDimAdaptive | MfScHRefinementLocalAdaptive)

Employ h-refinement to refine the grid

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.bayesian.BayesMfScQuadratureOrderSequence(*, quadrature_order_sequence: MfScQuadratureOrderSequenceConfig)

Sequence of quadrature orders used in a multi-stage expansion

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.bayesian.BayesMfScSGLevelSequence(*, sparse_grid_level_sequence: BayesMfScSGLevelSequenceConfig)

Sequence of sparse grid levels used in a multi-stage expansion

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.bayesian.Values(*, values: ValuesConfig)

Specifies matrix values to use as the MCMC proposal covariance.

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.bayesian.ProposalCovFile(*, file: FileConfig)

Uses a file to import a user-specified MCMC proposal covariance.

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.bayesian.BayesScPRefinement(*, p_refinement: ScPRefinementUniform | BayesScPRefinementDimAdaptive)

Automatic polynomial order 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.bayesian.BayesScHRefinement(*, h_refinement: ScPRefinementUniform | ScHRefinementDimAdaptive | BayesScHRefinementLocalAdaptive)

Employ h-refinement to refine the grid

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.bayesian.BayesScQuadratureOrder(*, quadrature_order: BayesScQuadratureOrderConfig)

Order for tensor-products of Gaussian quadrature rules

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.bayesian.BayesScSGLevel(*, sparse_grid_level: BayesScSGLevelConfig)

Level to use in sparse grid integration or interpolation

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.bayesian.EmulatorGPConfig(*, implementation: EmulatorGPSurfpack | EmulatorGPDakota, build_samples: int = 0, posterior_adaptive: Literal[True] | None = None, import_build_points_file: GPImportBuildPointsFile | None = None)

Gaussian Process surrogate model

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.bayesian.EmulatorPceOrthogLeastInterpConfig(*, collocation_points: int, tensor_grid: list[int] | None = None, reuse_points: Literal[True] | None = None, import_build_points_file: EmulatorPceOrthogLeastInterpImportBuildPointsFile | None = None, posterior_adaptive: Literal[True] | None = None)

Build a polynomial chaos expansion from simulation samples using orthogonal least interpolation.

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.bayesian.EmulatorMlPceOrthogLeastInterpConfig(*, collocation_points_sequence: list[int], tensor_grid: list[int] | None = None, reuse_points: Literal[True] | None = None, import_build_points_file: EmulatorPceOrthogLeastInterpImportBuildPointsFile | None = None)

Build a polynomial chaos expansion from simulation samples using orthogonal least interpolation.

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.bayesian.EmulatorPceExpansionOrderCollocPoints(*, collocation_points: EmulatorPceExpansionOrderCollocPointsConfig)

Number of collocation points used to estimate expansion coefficients

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.bayesian.EmulatorPceExpansionOrderCollocRatio(*, collocation_ratio: EmulatorPceExpansionOrderCollocRatioConfig)

Set the number of points used to build a PCE via regression to be proportional to the number of terms in the expansion.

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.bayesian.EmulatorMlPceExpansionOrderSequenceCollocRatio(*, collocation_ratio: EmulatorMlPceExpansionOrderSequenceCollocRatioConfig)

Set the number of points used to build a PCE via regression to be proportional to the number of terms in the expansion.

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.bayesian.EmulatorMfPceExpansionOrderSequenceCollocRatio(*, collocation_ratio: EmulatorMfPceExpansionOrderSequenceCollocRatioConfig)

Set the number of points used to build a PCE via regression to be proportional to the number of terms in the expansion.

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.bayesian.ScConfig(*, refinement_method: EmulatorScPRefinement | EmulatorScHRefinement | None = None, max_refinement_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807, grid_type: EmulatorScQuadratureOrder | EmulatorScSGLevel, basis_family: EmulatorScPiecewise | EmulatorPceAskey | EmulatorPceWiener | None = None, use_derivatives: Literal[True] | None = None, covariance_type: EmulatorPceDiagCov | EmulatorPceFullCov | None = None)

Stochastic Collocation as an emulator model.

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.bayesian.MfScConfig(*, refinement_method: EmulatorMfScPRefinement | EmulatorMfScHRefinement | None = None, max_refinement_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807, allocation_control: EmulatorMfPceAllocationControlGreedy | None = None, discrepancy_emulation: EmulatorMlPceDiscrepancyEmulationDistinct | EmulatorMlPceDiscrepancyEmulationRecursive | None = None, grid_type: EmulatorMfScQuadratureOrderSequence | EmulatorMfScSGLevelSequence, basis_family: EmulatorScPiecewise | EmulatorPceAskey | EmulatorPceWiener | None = None, use_derivatives: Literal[True] | None = None, covariance_type: EmulatorPceDiagCov | EmulatorPceFullCov | None = None)

Multifidelity Stochastic Collocation as an emulator model.

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.bayesian.BayesMfScMfSc(*, refinement_method: BayesMfScPRefinement | BayesMfScHRefinement | None = None, max_refinement_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807, allocation_control: MfScAllocationControlGreedy | None = None, discrepancy_emulation: MfScDiscrepancyEmulationDistinct | MfScDiscrepancyEmulationRecursive | None = None, grid_type: BayesMfScQuadratureOrderSequence | BayesMfScSGLevelSequence, basis_family: MfScPiecewise | MfScAskey | MfScWiener | None = None, use_derivatives: Literal[True] | None = None, covariance_type: MfScDiagCov | MfScFullCov | None = None)

Multifidelity Stochastic Collocation as an emulator model.

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.bayesian.BayesProposalCovMixin(*, proposal_covariance: Prior | Derivatives | Values | ProposalCovFile | None = None)

Generated model for BayesProposalCovMixin

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.bayesian.BayesScSc(*, refinement_method: BayesScPRefinement | BayesScHRefinement | None = None, max_refinement_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807, grid_type: BayesScQuadratureOrder | BayesScSGLevel, basis_family: BayesScPiecewise | ScAskey | ScWiener | None = None, use_derivatives: Literal[True] | None = None, covariance_type: ScDiagCov | ScFullCov | None = None)

Stochastic Collocation as an emulator model.

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.bayesian.EmulatorGP(*, gaussian_process: EmulatorGPConfig)

Gaussian Process surrogate model

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.bayesian.EmulatorPceOrthogLeastInterp(*, orthogonal_least_interpolation: EmulatorPceOrthogLeastInterpConfig)

Build a polynomial chaos expansion from simulation samples using orthogonal least interpolation.

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.bayesian.EmulatorMlPceOrthogLeastInterp(*, orthogonal_least_interpolation: EmulatorMlPceOrthogLeastInterpConfig)

Build a polynomial chaos expansion from simulation samples using orthogonal least interpolation.

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.bayesian.EmulatorMfPceOrthogLeastInterp(*, orthogonal_least_interpolation: EmulatorMlPceOrthogLeastInterpConfig)

Build a polynomial chaos expansion from simulation samples using orthogonal least interpolation.

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.bayesian.EmulatorPceExpansionOrderConfig(*, order: int = 65535, dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, basis_type: EmulatorPceExpansionOrderBasisTypeTensorProduct | EmulatorPceExpansionOrderBasisTypeTotalOrder | EmulatorPceExpansionOrderBasisTypeAdapted | None = None, point_selection: EmulatorPceExpansionOrderCollocPoints | EmulatorPceExpansionOrderCollocRatio | EmulatorPceExpansionOrderExpansionSamples, import_build_points_file: EmulatorPceExpansionOrderImportBuildPointsFile | None = None, posterior_adaptive: Literal[True] | None = None)

The (initial) order of a polynomial expansion

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.bayesian.EmulatorMlPceExpansionOrderSequenceConfig(*, sequence: list[int], dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, basis_type: EmulatorPceExpansionOrderBasisTypeTensorProduct | EmulatorPceExpansionOrderBasisTypeTotalOrder | EmulatorMlPceExpansionOrderSequenceBasisTypeAdapted | None = None, point_sequence_selection: EmulatorMlPceExpansionOrderSequenceCollocRatio | EmulatorMlPceExpansionOrderSequenceExpansionSamplesSequence, import_build_points_file: EmulatorPceOrthogLeastInterpImportBuildPointsFile | None = None)

Sequence of expansion orders used in a multi-stage expansion

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.bayesian.EmulatorMfPceExpansionOrderSequenceConfig(*, sequence: list[int], dimension_preference: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, basis_type: EmulatorPceExpansionOrderBasisTypeTensorProduct | EmulatorPceExpansionOrderBasisTypeTotalOrder | EmulatorMlPceExpansionOrderSequenceBasisTypeAdapted | None = None, point_sequence_selection: EmulatorMfPceExpansionOrderSequenceCollocRatio | EmulatorMfPceExpansionOrderSequenceExpansionSamplesSequence, import_build_points_file: EmulatorPceOrthogLeastInterpImportBuildPointsFile | None = None)

Sequence of expansion orders used in a multi-stage expansion

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.bayesian.EmulatorSc(*, sc: ScConfig)

Stochastic Collocation as an emulator model.

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.bayesian.EmulatorMfSc(*, mf_sc: MfScConfig)

Multifidelity Stochastic Collocation as an emulator model.

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.bayesian.BayesMfScMixin(*, mf_sc: BayesMfScMfSc)

Generated model for BayesMfScMixin

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.bayesian.BayesScMixin(*, sc: BayesScSc)

Generated model for BayesScMixin

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.bayesian.EmulatorPceExpansionOrder(*, expansion_order: EmulatorPceExpansionOrderConfig)

The (initial) order of a polynomial expansion

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.bayesian.EmulatorMlPceExpansionOrderSequence(*, expansion_order_sequence: EmulatorMlPceExpansionOrderSequenceConfig)

Sequence of expansion orders used in a multi-stage expansion

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.bayesian.EmulatorMfPceExpansionOrderSequence(*, expansion_order_sequence: EmulatorMfPceExpansionOrderSequenceConfig)

Sequence of expansion orders used in a multi-stage expansion

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.bayesian.BayesEmulatorPceConfig(*, p_refinement: EmulatorPcePRefinementUniform | EmulatorPcePRefinementDimAdaptive | None = None, max_refinement_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807, coefficient_approach: EmulatorPceQuadratureOrder | EmulatorPceSGLevel | EmulatorPceCubatureIntegrand | EmulatorPceExpansionOrder | EmulatorPceOrthogLeastInterp | EmulatorPceImportExpansionFile, basis_family: EmulatorPceAskey | EmulatorPceWiener | None = None, normalized: Literal[True] | None = None, export_expansion_file: str | None = None, covariance_type: EmulatorPceDiagCov | EmulatorPceFullCov | None = None)

Polynomial Chaos Expansion surrogate model

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.bayesian.BayesEmulatorMlPceConfig(*, allocation_control: EmulatorMlPceAllocationControlEstimatorVariance | EmulatorMlPceAllocationControlRipSampling | None = None, discrepancy_emulation: EmulatorMlPceDiscrepancyEmulationDistinct | EmulatorMlPceDiscrepancyEmulationRecursive | None = None, coefficient_approach: EmulatorMlPceExpansionOrderSequence | EmulatorMlPceOrthogLeastInterp, basis_family: EmulatorPceAskey | EmulatorPceWiener | None = None, normalized: Literal[True] | None = None, export_expansion_file: str | None = None, covariance_type: EmulatorPceDiagCov | EmulatorPceFullCov | None = None)

Multilevel Polynomial Chaos Expansion as an emulator model.

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.bayesian.BayesEmulatorMfPceConfig(*, p_refinement: EmulatorPcePRefinementUniform | EmulatorMfPcePRefinementDimAdaptive | None = None, max_refinement_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807, allocation_control: EmulatorMfPceAllocationControlGreedy | None = None, discrepancy_emulation: EmulatorMlPceDiscrepancyEmulationDistinct | EmulatorMlPceDiscrepancyEmulationRecursive | None = None, coefficient_approach: EmulatorMfPceQuadratureOrderSequence | EmulatorMfPceSGLevelSequence | EmulatorMfPceExpansionOrderSequence | EmulatorMfPceOrthogLeastInterp, basis_family: EmulatorPceAskey | EmulatorPceWiener | None = None, normalized: Literal[True] | None = None, export_expansion_file: str | None = None, covariance_type: EmulatorPceDiagCov | EmulatorPceFullCov | None = None)

Multifidelity Polynomial Chaos Expansion as an emulator model.

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.bayesian.EmulatorPce(*, pce: BayesEmulatorPceConfig)

Polynomial Chaos Expansion surrogate model

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.bayesian.EmulatorMlPce(*, ml_pce: BayesEmulatorMlPceConfig)

Multilevel Polynomial Chaos Expansion as an emulator model.

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.bayesian.EmulatorMfPce(*, mf_pce: BayesEmulatorMfPceConfig)

Multifidelity Polynomial Chaos Expansion as an emulator model.

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.bayesian.BayesEmulatorMixin(*, emulator: EmulatorGP | EmulatorPce | EmulatorMlPce | EmulatorMfPce | EmulatorSc | EmulatorMfSc | None = None)

Generated model for BayesEmulatorMixin

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