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:
AbstractFullCache
Cache using memory to cache all the data.
- Parameters:
Warning
If
is_memory_shared
isFalse
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 anif __name__ == '__main__':
statement when working on Windows.- cache_jacobian(input_data, jacobian_data)¶
Cache the input and Jacobian data.
- cache_outputs(input_data, output_data)¶
Cache input and output data.
- 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_group (bool) –
Whether to store the data by group in
Dataset.data
, in the sense of one unique NumPy array per group. Ifcategorize
isFalse
, there is a unique group:Dataset.PARAMETER_GROUP`
. Ifcategorize
isTrue
, the groups are stored inDataset.INPUT_GROUP
andDataset.OUTPUT_GROUP
. Ifby_group
isFalse
, 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.output_names (Iterable[str] | None) – The names of the outputs to be exported. If
None
, use all the outputs.
- Returns:
A dataset version of the cache.
- Return type:
- export_to_ggobi(file_path, input_names=None, output_names=None)¶
Export the cache to an XML file for ggobi tool.
- 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 (AbstractFullCache) – The cache to update the current one.
- Return type:
None
- values() an object providing a view on D's values ¶
- property copy: MemoryFullCache¶
Copy the current cache.
- Returns:
A copy of the current cache.
- property last_entry: 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.