gemseo / uncertainty / distributions

Hide inherited members

factory module

Module containing a factory to create an instance of BaseDistribution.

class gemseo.uncertainty.distributions.factory.DistributionFactory[source]

Bases: BaseFactory

Factory to build instances of BaseDistribution.

At initialization, this factory scans the following modules to search for subclasses of this class:

  • the modules located in gemseo.uncertainty.distributions and its sub-packages,

  • the modules referenced in the GEMSEO_PATH,

  • the modules referenced in the PYTHONPATH and starting with gemseo_.

Then, it can check if a class is present or return the list of available classes.

Lastly, it can create an instance of a class.

Examples

>>> from gemseo.uncertainty.distributions.factory import DistributionFactory
>>> factory = DistributionFactory()
>>> factory.is_available("OTNormalDistribution")
True
>>> factory.available_distributions[-3:]
['SPNormalDistribution', 'SPTriangularDistribution', 'SPUniformDistribution']
>>> distribution = factory.create("OTNormalDistribution", "x")
>>> print(distribution)
Normal(mu=0.0, sigma=1.0)
Return type:

Any

create(distribution_name, variable, **parameters)

Create a marginal probability distribution for a given random variable.

Parameters:

  • distribution_name (str) – The name of a class defining a distribution.

  • variable (str) – The name of the random variable.

  • **parameters (Any) – The parameters of the distribution.

Returns:

The marginal probability distribution.

Raises:

TypeError – If the class cannot be instantiated.

Return type:

BaseDistribution

create_joint_distribution(distributions, copula=None, variable='')[source]

Create a joint probability distribution from marginal ones.

Parameters:

  • distributions (Sequence[BaseDistribution]) – The marginal distributions.

  • copula (Any) – A copula distribution defining the dependency structure between random variables; if None, consider an independent copula.

  • variable (str) –

    The name of the variable, if any; otherwise, concatenate the names of the random variables defined by distributions.

    By default it is set to “”.

Returns:

The joint probability distribution.

Return type:

BaseJointDistribution

create_marginal_distribution(distribution_name, variable, **parameters)[source]

Create a marginal probability distribution for a given random variable.

Parameters:

  • distribution_name (str) – The name of a class defining a distribution.

  • variable (str) – The name of the random variable.

  • **parameters (Any) – The parameters of the distribution.

Returns:

The marginal probability distribution.

Raises:

TypeError – If the class cannot be instantiated.

Return type:

BaseDistribution

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[T]

get_default_option_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_option_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:

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='')

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 (Path | str) –

    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 “”.

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:

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: ClassVar[str] = 'gemseo_plugins'

The name of the setuptools entry point for declaring plugins.

property available_distributions: list[str]

The available probability distributions.

property class_names: list[str]

The sorted names of the available classes.

failed_imports: dict[str, str]

The class names bound to the import errors.