estimator module¶
Base estimator of statistic associated with a U-MDO formulation.
- class gemseo_umdo.estimators.estimator.BaseStatisticEstimator(formulation)[source]¶
Bases:
object
The base estimator of statistics associated with a U-MDO formulation.
# noqa: D205 D212 D415 :param formulation: The U-MDO formulation.
- Parameters
formulation (UMDOFormulation) –
- Return type
None
- class gemseo_umdo.estimators.estimator.BaseStatisticEstimatorFactory(*args, **kwargs)[source]¶
Bases:
gemseo.core.factory.Factory
The factory of
BaseStatisticEstimator
.# noqa: D205 D212 D415 :param cls: The class of statistic estimators.
- Parameters
cls (type) –
- Return type
None
- static cache_clear()¶
- create(name, formulation, **options)[source]¶
Create a statistic estimator.
- Parameters
name (str) – The class name of the statistic estimator.
formulation (UMDOFormulation) – The U-MDO formulation.
**options (Any) – The options of the statistic estimator.
- Return type
- 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
- get_default_options_values(name)¶
Return the constructor kwargs default values of a class.
- get_default_sub_options_values(name, **options)¶
Return the default values of the sub options of a class.
- Parameters
- Returns
The JSON grammar.
- Return type
- get_library_name(name)¶
Return the name of the library related to the name of a class.
- get_options_doc(name)¶
Return the constructor documentation of a class.
- 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
- get_sub_options_grammar(name, **options)¶
Return the JSONGrammar of the sub options of a class.
- Parameters
- Returns
The JSON grammar.
- Return type
- is_available(name)¶
Return whether a class can be instantiated.
- update()¶
Search for the classes that can be instantiated.
- The search is done in the following order:
The fully qualified module names
The plugin packages
The packages from the environment variables
- Return type
None
- PLUGIN_ENTRY_POINT = 'gemseo_plugins'¶