Model

pydantic model dakota.spec.model.ModelSelection

Base class for model discriminator wrappers

Show JSON schema
{
   "title": "ModelSelection",
   "description": "Base class for model discriminator wrappers",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Generated Pydantic models for model

class dakota.spec.model.SolutionLevelCost(*, solution_level_cost: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]])

Cost estimates associated with a set of solution control values.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.CostRecoveryMetadata(*, cost_recovery_metadata: str)

Identify metadata by label for capturing online cost estimates

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.TrendNone(*, none: Literal[True] = True)

No trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGPTrendConstant(*, constant: Literal[True] = True)

Constant trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGPTrendLinear(*, linear: Literal[True] = True)

Use a linear polynomial or trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGPTrendReducedQuadratic(*, reduced_quadratic: Literal[True] = True)

Quadratic polynomials - main effects only

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGPTrendQuadratic(*, quadratic: Literal[True] = True)

Use a quadratic polynomial or trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGPNugget(*, nugget: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)])

Value for the fixed nugget parameter

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGPFindNugget(*, find_nugget: int)

Use regression to estimate the nugget.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.DakotaTrendConstant(*, constant: Literal[True] = True)

Constant trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.DakotaTrendLinear(*, linear: Literal[True] = True)

Use a linear polynomial or trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.DakotaTrendReducedQuadratic(*, reduced_quadratic: Literal[True] = True)

Quadratic polynomials - main effects only

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SurfpackTrendConstant(*, constant: Literal[True] = True)

Constant trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SurfpackTrendLinear(*, linear: Literal[True] = True)

Use a linear polynomial or trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SurfpackTrendReducedQuadratic(*, reduced_quadratic: Literal[True] = True)

Quadratic polynomials - main effects only

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SurfpackTrendQuadratic(*, quadratic: Literal[True] = True)

Use a quadratic polynomial or trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SurfpackNugget(*, nugget: Annotated[float, Gt(gt=0.0), PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)])

Specify a nugget to handle ill-conditioning

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SurfpackFindNugget(*, find_nugget: int)

Have Surfpack compute a nugget to handle ill-conditioning

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.InterpLinear(*, linear: Literal[True] = True)

Linear 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.model.InterpCubic(*, cubic: Literal[True] = True)

Cubic 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.model.MovingLeastSquaresConfig(*, import_model: ImportModel | None = None, export_model: ModelPartialSurrogateExportFormatExportModel | None = None, basis_order: Annotated[int, Ge(ge=0)] = 2, weight_function: int = 0)

Moving Least Squares surrogate models

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ModelSurrogateGlobalApproxFtConfig(*, start_rank: Annotated[int, Ge(ge=0)] = 2, adapt_rank: Literal[True] | None = None, kick_rank: Annotated[int, Gt(gt=0)] = 1, max_rank: Annotated[int, Ge(ge=0)] = 9223372036854775807, max_cv_rank_candidates: Annotated[int, Ge(ge=0)] = 9223372036854775807, start_order: FtModelOrderStartOrder | None = None, adapt_order: Literal[True] | None = None, kick_order: Annotated[int, Gt(gt=0)] = 1, max_order: Annotated[int, Ge(ge=0)] = 65535, max_cv_order_candidates: Annotated[int, Ge(ge=0)] = 65535, rounding_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1e-10, arithmetic_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1e-10, regression_type: FtModelRegressionOptsTypeLs | FtModelRegressionOptsTypeRls2 | None = None, max_solver_iterations: Annotated[int, Ge(ge=0)] = 9223372036854775807, max_cross_iterations: Annotated[int, Ge(ge=0)] = 1, solver_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1e-10, response_scaling: Literal[True] | None = None, tensor_grid: Literal[True] | None = None)

Global surrogate model based on functional tensor train 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.model.NeuralNetworkConfig(*, import_model: ImportModel | None = None, export_model: ModelFullSurfpackExportFormatExportModel | None = None, max_nodes: int = 0, range: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 0.0, random_weight: int = 0)

Artificial neural network 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.model.RadialBasisConfig(*, import_model: ImportModel | None = None, export_model: ModelFullSurfpackExportFormatExportModel | None = None, bases: int = 0, max_pts: int = 0, min_partition: int = 0, max_subsets: int = 0)

Radial basis function (RBF) 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.model.BasisOrder(*, basis_order: Annotated[int, Ge(ge=0)])

Polynomial order

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.PolynomialLinear(*, linear: Literal[True] = True)

Use a linear polynomial or trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.PolynomialQuadratic(*, quadratic: Literal[True] = True)

Use a quadratic polynomial or trend function

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.PolynomialCubic(*, cubic: Literal[True] = True)

Use a cubic polynomial

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalPolynomialConfig(*, import_model: ImportModel | None = None, export_model: ModelPartialSurrogateExportFormatExportModel | None = None, basis_order: Annotated[int, Ge(ge=0)] = 2, options_file: str | None = None)

Use a deterministic polynomial 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.model.ExperimentalPythonConfig(*, class_path_and_name: str)

Use the experimental python surrogates interface

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.JumpThreshold(*, jump_threshold: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)])

Gradient Threshold Parameter of the Optional Discontinuity Detection Capability for the Piecewise Decomposition Option of Global 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.model.GradientThreshold(*, gradient_threshold: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)])

Gradient Threshold Parameter of the Optional Discontinuity Detection Capability for the Piecewise Decomposition Option of Global 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.model.TotalPoints(*, total_points: int)

Specified number of training points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.MinimumPoints(*, minimum_points: Literal[True] = True)

Construct surrogate with minimum number of points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.RecommendedPoints(*, recommended_points: Literal[True] = True)

Construct surrogate with recommended number of points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.CVMetric(*, metric: str = 'root_mean_squared', folds: Annotated[int, Gt(gt=0)] = 10)

Choice of error metric to satisfy

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxTruthModelPointer(*, truth_model_pointer: str)

A surrogate model pointer that guides a method to whether it should use a surrogate model or compute truth function evaluations

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ReusePointsAll(*, all: Literal[True] = True)

Option for reuse_points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Region(*, region: Literal[True] = True)

Option for reuse_points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ReusePointsNone(*, none: Literal[True] = True)

Option for reuse_points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ImportBuildPointsFileCustomAnnotatedHeader(*, use_variable_labels: Literal[True] | None = None)

Enable header row in custom-annotated tabular 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.model.ImportBuildPointsFileAnnotatedConfig(*, use_variable_labels: Literal[True] | None = None)

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.model.GlobalApproxImportBuildPointsFileFreeform(*, 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.model.GlobalApproxExportApproxPointsFileCustomAnnotatedConfig(*, 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.model.GlobalApproxExportApproxPointsFileAnnotated(*, 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.model.GlobalApproxExportApproxPointsFileFreeform(*, 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.model.Folds(*, folds: int)

Number of cross validation folds

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Percent(*, percent: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)])

Percent data per cross validation fold

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ImportChallengePointsFileCustomAnnotatedHeader(*, use_variable_labels: Literal[True] | None = None)

Enable header row in custom-annotated tabular 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.model.ImportChallengePointsFileAnnotatedConfig(*, use_variable_labels: Literal[True] | None = None)

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.model.ImportChallengePointsFileFreeform(*, 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.model.Tana(*, tana: Literal[True] = True)

Local multi-point model via two-point nonlinear approximation

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Qmea(*, qmea: Literal[True] = True)

Multi-point surrogate approximation based on QMEA algorithm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.LocalConfig(*, taylor_series: bool, truth_model_pointer: str)

Build a locally accurate surrogate from data at a single point

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.OrderedModelFidelitiesConfig(*, correction: Correction | None = None, pointers: list[str])

Specification of an hierarchy of model fidelities, ordered from low to high.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.TruthModelPointerConfig(*, pointer: str, approximation_models: list[str] | None = None)

Pointer to specify a "truth" model, from which to construct 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.model.OptionalInterfacePointer(*, pointer: str, optional_interface_responses_pointer: str | None = None)

Pointer to interface that provides non-nested responses

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SubMethodPointerIteratorSchedulingDedicated(*, dedicated: Literal[True] = True)

Specify a dedicated scheduler partition for concurrent iterator executions

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SubMethodPointerIteratorSchedulingPeer(*, peer: Literal[True] = True)

Specify a peer partition for parallel iterator scheduling

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ActiveSubspaceSampleTypeLhs(*, lhs: Literal[True] = True)

Uses Latin Hypercube Sampling (LHS) to sample variables

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ActiveSubspaceSampleTypeRandom(*, random: Literal[True] = True)

Uses purely random Monte Carlo sampling to sample variables

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Energy(*, truncation_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1e-06)

Truncate the subspace based on eigenvalue energy

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Minimum(*, minimum: Literal[True] = True)

Select subspace to minimize cross-validation error

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.CVRelative(*, relative: Literal[True] = True)

Choose subspace with cross-validation error less than tolerance

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Decrease(*, decrease: Literal[True] = True)

Choose subspace where cross-validation error stabilizes

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.BuildSurrogate(*, refinement_samples: list[int] | None = None)

Construct moving least squares surrogate over active subspace

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.MeanValue(*, mean_value: Literal[True] = True)

Normalize by sample mean of function values

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.MeanGradient(*, mean_gradient: Literal[True] = True)

Normalize by sample mean of gradient norms

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.LocalGradient(*, local_gradient: Literal[True] = True)

Normalize each gradient sample by its norm

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.TruthModelPointerSGLevel(*, sparse_grid_level: int)

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.model.TruthModelPointerExpansionOrderConfig(*, order: int, collocation_ratio: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)])

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.model.Unranked(*, unranked: Literal[True] = True)

Use the unranked method to obtain the rotation 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.model.Ranked(*, ranked: Literal[True] = True)

Use the ranked method to obtain the rotation 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.model.RfDataFile(*, rf_data_file: str)

Specify that the random field will be built from a file of data. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.BuildSourceDaceMethodPointer(*, dace_method_pointer: str)

Pointer to a DACE method for purposes of generating an ensemble of field responses to be used in estimating a random field model. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SquaredExponential(*, squared_exponential: Literal[True] = True)

Specify a squared exponential covariance in the case where the random field is built from an analytic covariance functio. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Exponential(*, exponential: Literal[True] = True)

Specify an exponential covariance in the case where the random field is built from an analytic covariance functio. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.KarhunenLoeve(*, karhunen_loeve: Literal[True] = True)

Specify Karhunen-Loeve as the expansion form to be used in the random field representation. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExpansionFormPrincipalComponents(*, principal_components: Literal[True] = True)

Specify Principal Components as the form of the expansion to be used in the random field representation. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SingleConfig(*, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None, interface_pointer: str | None = None, solution_level_control: str | None = None, cost_model: SolutionLevelCost | CostRecoveryMetadata | None = None)

A model with one of each block: variable, interface, and response

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGPConfig(*, import_model: ImportModel | None = None, export_model: ModelPartialSurrogateExportFormatExportModel | None = None, export_approx_variance_file: ExportApproxVarianceFile | None = None, trend: TrendNone | ExperimentalGPTrendConstant | ExperimentalGPTrendLinear | ExperimentalGPTrendReducedQuadratic | ExperimentalGPTrendQuadratic = <factory>, num_restarts: Annotated[int, ~annotated_types.Gt(gt=1)] = 10, nugget: ExperimentalGPNugget | ExperimentalGPFindNugget | None = None, options_file: str | None = None)

Use the Gaussian process regression surrogate from the surrogates module

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GPDakotaConfig(*, point_selection: Literal[True] | None = None, trend: DakotaTrendConstant | DakotaTrendLinear | DakotaTrendReducedQuadratic = <factory>)

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.model.GlobalApproxGPSurfpackConfig(*, import_model: ImportModel | None = None, export_model: ModelFullSurfpackExportFormatExportModel | None = None, trend: SurfpackTrendConstant | SurfpackTrendLinear | SurfpackTrendReducedQuadratic | SurfpackTrendQuadratic = <factory>, optimization_method: str | None = None, max_trials: Annotated[int | None, ~annotated_types.Gt(gt=0)] = None, nugget: SurfpackNugget | SurfpackFindNugget | None = None, correlation_lengths: list[~typing.Annotated[float, ~pydantic.functional_serializers.PlainSerializer(func=~dakota.spec.base._serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None)

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.model.MarsConfig(*, import_model: ImportModel | None = None, export_model: ModelPartialSurrogateExportFormatExportModel | None = None, max_bases: int = 0, interpolation: InterpLinear | InterpCubic | None = None)

Multivariate Adaptive Regression Spline (MARS)

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.MovingLeastSquares(*, moving_least_squares: MovingLeastSquaresConfig)

Moving Least Squares surrogate models

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Ft(*, function_train: ModelSurrogateGlobalApproxFtConfig)

Global surrogate model based on functional tensor train 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.model.NeuralNetwork(*, neural_network: NeuralNetworkConfig)

Artificial neural network 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.model.RadialBasis(*, radial_basis: RadialBasisConfig)

Radial basis function (RBF) 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.model.GlobalApproxPolynomialConfig(*, import_model: ImportModel | None = None, export_model: ModelFullSurfpackExportFormatExportModel | None = None, order: BasisOrder | PolynomialLinear | PolynomialQuadratic | PolynomialCubic)

Polynomial 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.model.ExperimentalPolynomial(*, experimental_polynomial: ExperimentalPolynomialConfig)

Use a deterministic polynomial 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.model.ExperimentalPython(*, experimental_python: ExperimentalPythonConfig)

Use the experimental python surrogates interface

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.DomainDecomposition(*, cell_type: str = 'voronoi', support_layers: int = 0, discontinuity_detection: JumpThreshold | GradientThreshold | None = None)

Piecewise Domain Decomposition for Global Surrogate Models

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.AutoRefinement(*, max_iterations: Annotated[int, Gt(gt=0)] = 9223372036854775807, max_function_evaluations: Annotated[int, Gt(gt=0)] = 9223372036854775807, convergence_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 0.0001, soft_convergence_limit: Annotated[int, Ge(ge=0)] = 0, cross_validation_metric: CVMetric | None = None)

Experimental auto-refinement of 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.model.ReusePoints(*, reuse_domain: ReusePointsAll | Region | ReusePointsNone)

Surrogate model training data reuse control

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxImportBuildPointsFileCustomAnnotatedConfig(*, header: ImportBuildPointsFileCustomAnnotatedHeader | 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.model.GlobalApproxImportBuildPointsFileAnnotated(*, annotated: ImportBuildPointsFileAnnotatedConfig = <factory>)

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.model.GlobalApproxExportApproxPointsFileCustomAnnotated(*, custom_annotated: GlobalApproxExportApproxPointsFileCustomAnnotatedConfig = <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.model.Metrics(*, metrics: list[str], cross_validation: Folds | Percent | dict | None = None, press: Literal[True] | None = None)

Compute surrogate quality metrics

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ImportChallengePointsFileCustomAnnotatedConfig(*, header: ImportChallengePointsFileCustomAnnotatedHeader | 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.model.ImportChallengePointsFileAnnotated(*, annotated: ImportChallengePointsFileAnnotatedConfig = <factory>)

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.model.MultipointConfig(*, type: Tana | Qmea, truth_model_pointer: str)

Construct a surrogate from multiple existing training points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.OrderedModelFidelities(*, ordered_model_fidelities: OrderedModelFidelitiesConfig)

Specification of an hierarchy of model fidelities, ordered from low to high.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.EnsembleTruthModelPointer(*, truth_model_pointer: TruthModelPointerConfig)

Pointer to specify a "truth" model, from which to construct 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.model.SubMethodPointer(*, pointer: str, iterator_servers: Annotated[int | None, Gt(gt=0)] = None, iterator_scheduling: SubMethodPointerIteratorSchedulingDedicated | SubMethodPointerIteratorSchedulingPeer | None = None, processors_per_iterator: Annotated[int | None, Gt(gt=0)] = None, primary_variable_mapping: list[str] | None = None, secondary_variable_mapping: list[str] | None = None, primary_response_mapping: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, secondary_response_mapping: list[Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)]] | None = None, identity_response_mapping: Literal[True] | None = None)

The sub_method_pointer specifies the method block for the sub-iterator

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.TruncationMethodCV(*, criterion: Minimum | CVRelative | Decrease | None = None, relative_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1e-06, decrease_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1e-06, max_rank: int = -1, exhaustive: Literal[True] | None = None)

Truncate the subspace to minimize surrogate cross-validation error

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.TruthModelPointerExpansionOrder(*, expansion_order: TruthModelPointerExpansionOrderConfig)

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.model.AnalyticCov(*, analytic_covariance: SquaredExponential | Exponential)

Use an analytic covariance function for the purposes of generating a random field model. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SingleSelection(*, single: SingleConfig)

A model with one of each block: variable, interface, and response

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ExperimentalGP(*, experimental_gaussian_process: ExperimentalGPConfig)

Use the Gaussian process regression surrogate from the surrogates module

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxGPDakota(*, dakota: GPDakotaConfig)

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.model.GlobalApproxGPSurfpack(*, surfpack: GlobalApproxGPSurfpackConfig)

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.model.Mars(*, mars: MarsConfig)

Multivariate Adaptive Regression Spline (MARS)

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxPolynomial(*, polynomial: GlobalApproxPolynomialConfig)

Polynomial 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.model.DaceMethodPointerConfig(*, pointer: str, auto_refinement: AutoRefinement | None = None)

Specify a method to gather training data

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxImportBuildPointsFileCustomAnnotated(*, custom_annotated: GlobalApproxImportBuildPointsFileCustomAnnotatedConfig = <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.model.GlobalApproxExportApproxPointsFile(*, filename: str, format: GlobalApproxExportApproxPointsFileCustomAnnotated | GlobalApproxExportApproxPointsFileAnnotated | GlobalApproxExportApproxPointsFileFreeform = <factory>)

Output file for surrogate model value evaluations

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ImportChallengePointsFileCustomAnnotated(*, custom_annotated: ImportChallengePointsFileCustomAnnotatedConfig = <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.model.Multipoint(*, multipoint: MultipointConfig)

Construct a surrogate from multiple existing training points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.Ensemble(*, ensemble: OrderedModelFidelities | EnsembleTruthModelPointer)

Ensemble surrogates employ a collection of lower-fidelity models to approximate a truth reference model at reduced cost.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.NestedConfig(*, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None, optional_interface_pointer: OptionalInterfacePointer | None = None, sub_method_pointer: SubMethodPointer)

A model whose responses are computed through the use of a sub-iterator

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.TruncationMethod(*, bing_li: Literal[True] | None = None, constantine: Literal[True] | None = None, energy: Energy | None = None, cross_validation: TruncationMethodCV | None = None)

Metric that estimates active subspace size

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.AdaptedBasisTruthModelPointer(*, pointer: str, basis_control: TruthModelPointerSGLevel | TruthModelPointerExpansionOrder, dimension: int = 0, rotation_method: Unranked | Ranked = <factory>)

Pointer to specify a "truth" model, from which to construct 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.model.RandomFieldConfig(*, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None, build_source: RfDataFile | BuildSourceDaceMethodPointer | AnalyticCov | None = None, expansion_form: KarhunenLoeve | ExpansionFormPrincipalComponents | None = None, expansion_bases: int = 0, truncation_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 1e-06, propagation_model_pointer: str)

Experimental capability to generate a random field representation. from data, from simulation runs, or from a covariance matrix. The representation may then be sampled for use as a random field input to another simulation. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxGPConfig(*, export_approx_variance_file: ExportApproxVarianceFile | None = None, gp_implementation: GlobalApproxGPDakota | GlobalApproxGPSurfpack | 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.model.GlobalApproxDaceMethodPointer(*, dace_method_pointer: DaceMethodPointerConfig)

Specify a method to gather training data

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxImportBuildPointsFile(*, filename: str, format: GlobalApproxImportBuildPointsFileCustomAnnotated | GlobalApproxImportBuildPointsFileAnnotated | GlobalApproxImportBuildPointsFileFreeform = <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.model.ImportChallengePointsFile(*, filename: str, format: ImportChallengePointsFileCustomAnnotated | ImportChallengePointsFileAnnotated | ImportChallengePointsFileFreeform = <factory>, active_only: Literal[True] | None = None)

Datafile of points to assess surrogate quality

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.NestedSelection(*, nested: NestedConfig)

A model whose responses are computed through the use of a sub-iterator

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.ActiveSubspaceConfig(*, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None, truth_model_pointer: str, initial_samples: int = 0, sample_type: ActiveSubspaceSampleTypeLhs | ActiveSubspaceSampleTypeRandom | None = None, truncation_method: TruncationMethod | None = None, dimension: int = 0, bootstrap_samples: int = 100, build_surrogate: BuildSurrogate | None = None, normalization: MeanValue | MeanGradient | LocalGradient | None = None)

Active (variable) subspace 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.model.AdaptedBasisConfig(*, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None, truth_model_pointer: AdaptedBasisTruthModelPointer, truncation_tolerance: Annotated[float, PlainSerializer(func=_serialize_dakota_float, return_type=float | str, when_used=json)] = 0.9)

Basis adaptation 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.model.RandomFieldSelection(*, random_field: RandomFieldConfig)

Experimental capability to generate a random field representation. from data, from simulation runs, or from a covariance matrix. The representation may then be sampled for use as a random field input to another simulation. THIS IS AN EXPERIMENTAL CAPABILITY.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.GlobalApproxGP(*, gaussian_process: GlobalApproxGPConfig)

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.model.ActiveSubspaceSelection(*, active_subspace: ActiveSubspaceConfig)

Active (variable) subspace 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.model.AdaptedBasisSelection(*, adapted_basis: AdaptedBasisConfig)

Basis adaptation 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.model.GlobalApproxConfig(*, correction: Correction | None = None, type: ExperimentalGP | GlobalApproxGP | Mars | MovingLeastSquares | Ft | NeuralNetwork | RadialBasis | GlobalApproxPolynomial | ExperimentalPolynomial | ExperimentalPython, domain_decomposition: DomainDecomposition | None = None, build_points: TotalPoints | MinimumPoints | RecommendedPoints | None = None, build_data: GlobalApproxDaceMethodPointer | GlobalApproxTruthModelPointer | None = None, reuse_points: ReusePoints | None = None, import_build_points_file: GlobalApproxImportBuildPointsFile | None = None, export_approx_points_file: GlobalApproxExportApproxPointsFile | None = None, use_derivatives: Literal[True] | None = None, metrics: Metrics | None = None, import_challenge_points_file: ImportChallengePointsFile | None = None)

Select a surrogate model with global support

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.SurrogateFunctionIndicesMixin(*, id_surrogates: list[int] | None = None)

Shared response-function selection for data-fit surrogate models

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.model.GlobalSurrogateConfig(*, correction: Correction | None = None, type: ExperimentalGP | GlobalApproxGP | Mars | MovingLeastSquares | Ft | NeuralNetwork | RadialBasis | GlobalApproxPolynomial | ExperimentalPolynomial | ExperimentalPython, domain_decomposition: DomainDecomposition | None = None, build_points: TotalPoints | MinimumPoints | RecommendedPoints | None = None, build_data: GlobalApproxDaceMethodPointer | GlobalApproxTruthModelPointer | None = None, reuse_points: ReusePoints | None = None, import_build_points_file: GlobalApproxImportBuildPointsFile | None = None, export_approx_points_file: GlobalApproxExportApproxPointsFile | None = None, use_derivatives: Literal[True] | None = None, metrics: Metrics | None = None, import_challenge_points_file: ImportChallengePointsFile | None = None, id_surrogates: list[int] | None = None, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None)

An empirical model with global support, created from data or a submodel

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.model.GlobalSurrogateSelection(*, global_surrogate: GlobalSurrogateConfig)

An empirical model with global support, created from data or a submodel

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.MultipointSurrogateConfig(*, type: Tana | Qmea, truth_model_pointer: str, id_surrogates: list[int] | None = None, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None)

A surrogate constructed from multiple existing training points

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.model.MultipointSurrogateSelection(*, multipoint_surrogate: MultipointSurrogateConfig)

A surrogate constructed from multiple existing training points

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.LocalSurrogateConfig(*, taylor_series: bool, truth_model_pointer: str, id_surrogates: list[int] | None = None, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None)

A locally accurate surrogate constructed from data at a single point

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.model.LocalSurrogateSelection(*, local_surrogate: LocalSurrogateConfig)

A locally accurate surrogate constructed from data at a single point

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.model.EnsembleSurrogateConfig(*, id_model: str | None = None, variables_pointer: str | None = None, responses_pointer: str | None = None, hierarchical_tagging: Literal[True] | None = None, ensemble: OrderedModelFidelities | EnsembleTruthModelPointer)

A surrogate ensemble of lower-fidelity models and a truth 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.model.EnsembleSurrogateSelection(*, ensemble_surrogate: EnsembleSurrogateConfig)

An ensemble surrogate of lower-fidelity models and a truth 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