This is a pre-release version (2.5.0.dev0+git20251130.2de293a). Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy 2.5.0.dev0+git20251130.2de293a / numpy / savez_compressed

_ArrayFunctionDispatcher

numpy:savez_compressed

source: /dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/lib/_npyio_impl.py :681

Signature

def   savez_compressed ( file * args allow_pickle = True ** kwds )

Summary

Save several arrays into a single file in compressed .npz format.

Extended Summary

Provide arrays as keyword arguments to store them under the corresponding name in the output file: savez_compressed(fn, x=x, y=y).

If arrays are specified as positional arguments, i.e., savez_compressed(fn, x, y), their names will be arr_0, arr_1, etc.

Parameters

file : file, str, or pathlib.Path

Either the filename (string) or an open file (file-like object) where the data will be saved. If file is a string or a Path, the .npz extension will be appended to the filename if it is not already there.

args : Arguments, optional

Arrays to save to the file. Please use keyword arguments (see kwds below) to assign names to arrays. Arrays specified as args will be named "arr_0", "arr_1", and so on.

allow_pickle : bool, optional

Allow saving object arrays using Python pickles. Reasons for disallowing pickles include security (loading pickled data can execute arbitrary code) and portability (pickled objects may not be loadable on different Python installations, for example if the stored objects require libraries that are not available, and not all pickled data is compatible between different versions of Python). Default: True

kwds : Keyword arguments, optional

Arrays to save to the file. Each array will be saved to the output file with its corresponding keyword name.

Returns

: None

Notes

The .npz file format is a zipped archive of files named after the variables they contain. The archive is compressed with zipfile.ZIP_DEFLATED and each file in the archive contains one variable in .npy format. For a description of the .npy format, see numpy.lib.format.

When opening the saved .npz file with load a ~lib.npyio.NpzFile object is returned. This is a dictionary-like object which can be queried for its list of arrays (with the .files attribute), and for the arrays themselves.

Examples

import numpy as np
test_array = np.random.rand(3, 2)
test_vector = np.random.rand(4)
np.savez_compressed('/tmp/123', a=test_array, b=test_vector)
loaded = np.load('/tmp/123.npz')
print(np.array_equal(test_array, loaded['a']))
print(np.array_equal(test_vector, loaded['b']))

See also

numpy.load

Load the files created by savez_compressed.

numpy.save

Save a single array to a binary file in NumPy format.

numpy.savetxt

Save an array to a file as plain text.

numpy.savez

Save several arrays into an uncompressed .npz file format

Aliases

  • numpy.savez_compressed

Referenced by