gemseo / caches

memory_full_cache module

Caching module to store all the entries in memory.

class gemseo.caches.memory_full_cache.MemoryFullCache(tolerance=0.0, name=None, is_memory_shared=True)[source]

Bases: gemseo.core.cache.AbstractFullCache

Cache using memory to cache all the data.

Parameters

  • is_memory_shared (bool) –

    If True, a shared memory dictionary is used to store the data, which makes the cache compatible with multiprocessing.

    By default it is set to True.

  • tolerance (float) –

    By default it is set to 0.0.

  • name (str | None) –

    By default it is set to None.

Return type

None

Warning

If is_memory_shared is False and multiple disciplines point to the same cache or the process is multi-processed, there may be duplicate computations because the cache will not be shared among the processes. This class relies on some multiprocessing features, it is therefore necessary to protect its execution with an if __name__ == '__main__': statement when working on Windows.

cache_jacobian(input_data, jacobian_data)

Cache the input and Jacobian data.

Parameters

  • input_data (Mapping[str, Any]) – The data containing the input data to cache.

  • jacobian_data (Mapping[str, Mapping[str, numpy.ndarray]]) – The Jacobian data to cache.

Return type

None

cache_outputs(input_data, output_data)

Cache input and output data.

Parameters

  • input_data (Mapping[str, Any]) – The data containing the input data to cache.

  • output_data (Mapping[str, Any]) – The data containing the output data to cache.

Return type

None

clear()[source]

Clear the cache.

Return type

None

export_to_dataset(name=None, by_group=True, categorize=True, input_names=None, output_names=None)

Build a Dataset from the cache.

Parameters

  • name (str | None) –

    A name for the dataset. If None, use the name of the cache.

    By default it is set to None.

  • by_group (bool) –

    Whether to store the data by group in Dataset.data, in the sense of one unique NumPy array per group. If categorize is False, there is a unique group: Dataset.PARAMETER_GROUP`. If categorize is True, the groups are stored in Dataset.INPUT_GROUP and Dataset.OUTPUT_GROUP. If by_group is False, store the data by variable names.

    By default it is set to True.

  • categorize (bool) –

    Whether to distinguish between the different groups of variables. Otherwise, group all the variables in Dataset.PARAMETER_GROUP`.

    By default it is set to True.

  • input_names (Iterable[str] | None) –

    The names of the inputs to be exported. If None, use all the inputs.

    By default it is set to None.

  • output_names (Iterable[str] | None) –

    The names of the outputs to be exported. If None, use all the outputs.

    By default it is set to None.

Returns

A dataset version of the cache.

Return type

Dataset

export_to_ggobi(file_path, input_names=None, output_names=None)

Export the cache to an XML file for ggobi tool.

Parameters

  • file_path (str) – The path of the file to export the cache.

  • input_names (Iterable[str] | None) –

    The names of the inputs to export. If None, export all of them.

    By default it is set to None.

  • output_names (Iterable[str] | None) –

    The names of the outputs to export. If None, export all of them.

    By default it is set to None.

Return type

None

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.
items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
update(other_cache)

Update from another cache.

Parameters

other_cache (gemseo.core.cache.AbstractFullCache) – The cache to update the current one.

Return type

None

values() → an object providing a view on D's values
property copy: gemseo.caches.memory_full_cache.MemoryFullCache

Copy the current cache.

Returns

A copy of the current cache.

property input_names: list[str]

The names of the inputs of the last entry.

property last_entry: gemseo.core.cache.CacheEntry

The last cache entry.

lock: RLock

The lock used for both multithreading and multiprocessing.

Ensure safe multiprocessing and multithreading concurrent access to the cache.

lock_hashes: RLock

The lock used for both multithreading and multiprocessing.

Ensure safe multiprocessing and multithreading concurrent access to the cache.

name: str

The name of the cache.

property names_to_sizes: dict[str, int]

The sizes of the variables of the last entry.

property output_names: list[str]

The names of the outputs of the last entry.

tolerance: float

The tolerance below which two input arrays are considered equal.