gemseo_umdo / estimators

sampling module

Estimators of statistic for sampling-based U-MDO formulation.

class gemseo_umdo.estimators.sampling.Margin(formulation)[source]

Bases: gemseo_umdo.estimators.sampling.SamplingEstimator

Estimator of a margin, i.e. mean + factor * deviation.

# noqa: D205 D212 D415 :param formulation: The U-MDO formulation.

Parameters

formulation (Sampling) –

Return type

None

class gemseo_umdo.estimators.sampling.Mean(formulation)[source]

Bases: gemseo_umdo.estimators.sampling.SamplingEstimator

Estimator of the expectation, a.k.a.

mean.

# noqa: D205 D212 D415 :param formulation: The U-MDO formulation.

Parameters

formulation (Sampling) –

Return type

None

class gemseo_umdo.estimators.sampling.Probability(formulation)[source]

Bases: gemseo_umdo.estimators.sampling.SamplingEstimator

Estimator of a probability.

# noqa: D205 D212 D415 :param formulation: The U-MDO formulation.

Parameters

formulation (Sampling) –

Return type

None

class gemseo_umdo.estimators.sampling.SamplingEstimator(formulation)[source]

Bases: gemseo_umdo.estimators.estimator.BaseStatisticEstimator

Base statistic estimator for a U-MDO formulation using sampling.

# noqa: D205 D212 D415 :param formulation: The U-MDO formulation.

Parameters

formulation (Sampling) –

Return type

None

class gemseo_umdo.estimators.sampling.SamplingEstimatorFactory(*args, **kwargs)[source]

Bases: gemseo.core.factory.Factory

The factory of SamplingEstimator.

Parameters

  • base_class – The base class to be considered.

  • module_names – The fully qualified modules names to be searched.

Return type

None

static cache_clear()
create(class_name, **options)

Return an instance of a class.

Parameters

  • class_name (str) – The name of the class.

  • **options (Any) – The arguments to be passed to the class constructor.

Returns

The instance of the class.

Raises

TypeError – If the class cannot be instantiated.

Return type

Any

get_class(name)

Return a class from its name.

Parameters

name (str) – The name of the class.

Returns

The class.

Raises

ImportError – If the class is not available.

Return type

type[Any]

get_default_options_values(name)

Return the constructor kwargs default values of a class.

Parameters

name (str) – The name of the class.

Returns

The mapping from the argument names to their default values.

Return type

dict[str, str | int | float | bool]

get_default_sub_options_values(name, **options)

Return the default values of the sub options of a class.

Parameters

  • name (str) – The name of the class.

  • **options (str) – The options to be passed to the class required to deduce the sub options.

Returns

The JSON grammar.

Return type

gemseo.core.grammars.json_grammar.JSONGrammar

get_library_name(name)

Return the name of the library related to the name of a class.

Parameters

name (str) – The name of the class.

Returns

The name of the library.

Return type

str

get_options_doc(name)

Return the constructor documentation of a class.

Parameters

name (str) – The name of the class.

Returns

The mapping from the argument names to their documentation.

Return type

dict[str, str]

get_options_grammar(name, write_schema=False, schema_path=None)

Return the options JSON grammar for a class.

Attempt to generate a JSONGrammar from the arguments of the __init__ method of the class.

Parameters

  • name (str) – The name of the class.

  • write_schema (bool) –

    If True, write the JSON schema to a file.

    By default it is set to False.

  • schema_path (str | None) –

    The path to the JSON schema file. If None, the file is saved in the current directory in a file named after the name of the class.

    By default it is set to None.

Returns

The JSON grammar.

Return type

JSONGrammar

get_sub_options_grammar(name, **options)

Return the JSONGrammar of the sub options of a class.

Parameters

  • name (str) – The name of the class.

  • **options (str) – The options to be passed to the class required to deduce the sub options.

Returns

The JSON grammar.

Return type

gemseo.core.grammars.json_grammar.JSONGrammar

is_available(name)

Return whether a class can be instantiated.

Parameters

name (str) – The name of the class.

Returns

Whether the class can be instantiated.

Return type

bool

update()

Search for the classes that can be instantiated.

The search is done in the following order:

  1. The fully qualified module names

  2. The plugin packages

  3. The packages from the environment variables

Return type

None

PLUGIN_ENTRY_POINT = 'gemseo_plugins'
property classes: list[str]

Return the available classes.

Returns

The sorted names of the available classes.

class gemseo_umdo.estimators.sampling.StandardDeviation(formulation)[source]

Bases: gemseo_umdo.estimators.sampling.Variance

Estimator of the standard deviation.

# noqa: D205 D212 D415 :param formulation: The U-MDO formulation.

Parameters

formulation (Sampling) –

Return type

None

class gemseo_umdo.estimators.sampling.Variance(formulation)[source]

Bases: gemseo_umdo.estimators.sampling.SamplingEstimator

Estimator of the variance.

# noqa: D205 D212 D415 :param formulation: The U-MDO formulation.

Parameters

formulation (Sampling) –

Return type

None