diff options
author | Pauli Virtanen <pav@iki.fi> | 2009-03-24 22:25:21 +0000 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2009-03-24 22:25:21 +0000 |
commit | 7b751f66c7feb71646f0c2540aca2e5e67cd5db5 (patch) | |
tree | 3c33eab7a5933af7300ee4949c541511ebb7f915 /numpy/lib/io.py | |
parent | 940a7d3b4e6398a742873347a2f3c605ceffe481 (diff) | |
download | numpy-7b751f66c7feb71646f0c2540aca2e5e67cd5db5.tar.gz |
Merge from the doc wiki
Diffstat (limited to 'numpy/lib/io.py')
-rw-r--r-- | numpy/lib/io.py | 43 |
1 files changed, 34 insertions, 9 deletions
diff --git a/numpy/lib/io.py b/numpy/lib/io.py index a4bd7f9ee..84790ac42 100644 --- a/numpy/lib/io.py +++ b/numpy/lib/io.py @@ -212,6 +212,11 @@ def save(file, arr): x : array_like Array data. + See Also + -------- + savez : Save several arrays into an .npz compressed archive + savetxt : Save an array to a file as plain text + Examples -------- >>> from tempfile import TemporaryFile @@ -237,21 +242,36 @@ def save(file, arr): def savez(file, *args, **kwds): """ - Save several arrays into an .npz file format which is a zipped-archive - of arrays + Save several arrays into a single, compressed file with extension ".npz" - If keyword arguments are given, then filenames are taken from the keywords. - If arguments are passed in with no keywords, then stored file names are - arr_0, arr_1, etc. + If keyword arguments are given, the names for variables assigned to the + keywords are the keyword names (not the variable names in the caller). + If arguments are passed in with no keywords, the corresponding variable + names are arr_0, arr_1, etc. Parameters ---------- - file : string - File name of .npz file. + file : Either the filename (string) or an open file (file-like object) + If file is a string, it names the output file. ".npz" will be appended + if it is not already there. args : Arguments - Function arguments. + Any function arguments other than the file name are variables to save. + Since it is not possible for Python to know their names outside the + savez function, they will be saved with names "arr_0", "arr_1", and so + on. These arguments can be any expression. kwds : Keyword arguments - Keywords. + All keyword=value pairs cause the value to be saved with the name of + the keyword. + + See Also + -------- + save : Save a single array to a binary file in NumPy format + savetxt : Save an array to a file as plain text + + Notes + ----- + The .npz file format is a zipped archive of files named after the variables + they contain. Each file contains one variable in .npy format. """ @@ -510,6 +530,11 @@ def savetxt(fname, X, fmt='%.18e',delimiter=' '): delimiter : str Character separating columns. + See Also + -------- + save : Save an array to a binary file in NumPy format + savez : Save several arrays into an .npz compressed archive + Notes ----- Further explanation of the `fmt` parameter |