cf.free_memory_factor

cf.free_memory_factor(*args)[source]

Set the fraction of memory kept free as a temporary workspace. Users should set the free memory factor through cf.set_performance so that the upper limit to the chunksize is recalculated appropriately. The free memory factor must be a sensible value between zero and one. If no arguments are passed the existing free memory factor is returned.

Parameters
free_memory_factor: float

The fraction of memory kept free as a temporary workspace.

Returns
float

The previous value of the free memory factor.