gemseo.post.som_settings module#

Settings for post-processing.

Settings SOM_Settings(*, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', fig_size=(12.0, 18.0), n_x=4, n_y=4, annotate=False)[source]#

Bases: BasePostSettings

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:

  • save (bool) --

    By default it is set to True.

  • show (bool) --

    By default it is set to False.

  • file_path (Path | str) --

    By default it is set to "".

  • directory_path (Path | str) --

    By default it is set to "".

  • file_name (str) --

    By default it is set to "".

  • file_extension (str) --

    By default it is set to "".

  • fig_size (tuple[Annotated[float, Gt(gt=0)], Annotated[float, Gt(gt=0)]]) --

    By default it is set to (12.0, 18.0).

  • n_x (Annotated[int, Gt(gt=0)]) --

    By default it is set to 4.

  • n_y (Annotated[int, Gt(gt=0)]) --

    By default it is set to 4.

  • annotate (bool) --

    By default it is set to False.

Return type:

None

annotate: bool = False#

Whether to show the label of the neuron value.

n_x: PositiveInt = 4#

The number of grids in x.

Constraints:

  • gt = 0

n_y: PositiveInt = 4#

The number of grids in y.

Constraints:

  • gt = 0

model_post_init(context, /)#

We need to both initialize private attributes and call the user-defined model_post_init method.

Parameters:

  • self (BaseModel)

  • context (Any)

Return type:

None