Surrogate

Generated Pydantic models for shared.surrogate

class dakota.spec.shared.surrogate.MethodExportApproxFormatCustomAnnotatedConfig(*, 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.surrogate.MethodExportApproxFormatAnnotated(*, 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.surrogate.MethodExportApproxFormatFreeform(*, 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.surrogate.MethodExportApproxPointsFileCustomAnnotatedConfig(*, 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.surrogate.MethodExportApproxPointsFileAnnotated(*, 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.surrogate.MethodExportApproxPointsFileFreeform(*, 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.surrogate.MethodImportApproxFormatCustomAnnotatedConfig(*, 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.surrogate.MethodImportApproxFormatAnnotated(*, 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.surrogate.MethodImportApproxFormatFreeform(*, 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.surrogate.ModelPartialSurrogateExportFormatFormats(*, text_archive: Literal[True] | None = None, binary_archive: Literal[True] | None = None)

Formats for surrogate model export

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.TextArchive(*, text_archive: Literal[True] = True)

Surrogate model plain-text archive 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.surrogate.BinaryArchive(*, binary_archive: Literal[True] = True)

Surrogate model binary archive 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.surrogate.ZerothOrder(*, zeroth_order: Literal[True] = True)

Specify that truth values must be matched.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.CorrectionFirstOrder(*, first_order: Literal[True] = True)

Specify that truth values and gradients must be matched.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.CorrectionSecondOrder(*, second_order: Literal[True] = True)

Specify that truth values, gradients and Hessians must be matched.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.Additive(*, additive: Literal[True] = True)

Additive correction factor for local surrogate accuracy

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.Multiplicative(*, multiplicative: Literal[True] = True)

Multiplicative correction factor for local surrogate accuracy.

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.CorrectionCombined(*, combined: Literal[True] = True)

Multipoint correction for a hierarchical 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.surrogate.MethodExportApproxFormatCustomAnnotated(*, custom_annotated: MethodExportApproxFormatCustomAnnotatedConfig = <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.surrogate.MethodExportApproxPointsFileCustomAnnotated(*, custom_annotated: MethodExportApproxPointsFileCustomAnnotatedConfig = <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.surrogate.MethodImportApproxFormatCustomAnnotated(*, custom_annotated: MethodImportApproxFormatCustomAnnotatedConfig = <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.surrogate.ModelPartialSurrogateExportFormatExportModel(*, filename_prefix: str = 'exported_surrogate', formats: ModelPartialSurrogateExportFormatFormats)

Exports surrogate model in user-specified format(s)

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.ImportModel(*, filename_prefix: str = 'exported_surrogate', import_format: TextArchive | BinaryArchive)

Import surrogate model from archive 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.surrogate.Correction(*, correction_order: ZerothOrder | CorrectionFirstOrder | CorrectionSecondOrder, correction_type: Additive | Multiplicative | CorrectionCombined)

Correction approaches for 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.shared.surrogate.MethodExportApproxFormatMixin(*, format: MethodExportApproxFormatCustomAnnotated | MethodExportApproxFormatAnnotated | MethodExportApproxFormatFreeform = <factory>)

Generated model for MethodExportApproxFormatMixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.MethodExportApproxPointsFileExportApproxPointsFile(*, filename: str, format: MethodExportApproxPointsFileCustomAnnotated | MethodExportApproxPointsFileAnnotated | MethodExportApproxPointsFileFreeform = <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.shared.surrogate.MethodImportApproxFormatMixin(*, format: MethodImportApproxFormatCustomAnnotated | MethodImportApproxFormatAnnotated | MethodImportApproxFormatFreeform = <factory>)

Generated model for MethodImportApproxFormatMixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.ModelPartialSurrogateExportFormatMixin(*, export_model: ModelPartialSurrogateExportFormatExportModel | None = None)

Generated model for ModelPartialSurrogateExportFormatMixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.ModelSurrogateImportMixin(*, import_model: ImportModel | None = None)

Generated model for ModelSurrogateImportMixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.SurrogateCorrectionMixin(*, correction: Correction | None = None)

Generated model for SurrogateCorrectionMixin

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

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

universal_validator()

Example universal validator that runs for all models

class dakota.spec.shared.surrogate.MethodExportApproxPointsFileMixin(*, export_approx_points_file: MethodExportApproxPointsFileExportApproxPointsFile | None = None)

Generated model for MethodExportApproxPointsFileMixin

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

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

universal_validator()

Example universal validator that runs for all models