noether.core.schemas.aero.callbacks

Classes

SurfaceVolumeEvaluationMetricsCallbackConfig

Configuration for surface/volume evaluation metrics callback.

Module Contents

class noether.core.schemas.aero.callbacks.SurfaceVolumeEvaluationMetricsCallbackConfig(/, **data)

Bases: noether.core.schemas.callbacks.PeriodicDataIteratorCallbackConfig

Configuration for surface/volume evaluation metrics callback.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

name: Literal['SurfaceVolumeEvaluationMetricsCallback'] = 'SurfaceVolumeEvaluationMetricsCallback'
forward_properties: list[str] = []

List of properties in the dataset to be forwarded during inference.

chunked_inference: bool = False

If True, perform inference in chunks over the full simulation geometry.

chunk_properties: list[str] = []

List of properties in the dataset to be chunked for chunked inference.

batch_size: int = None

Batch size for evaluation. Currently only batch_size=1 is supported.

chunk_size: int | None = None

Size of each chunk when performing chunked inference.

sample_size_property: str | None = None

Property in the batch to determine the sample size for chunking.

validate_config()
Return type:

SurfaceVolumeEvaluationMetricsCallbackConfig