diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2018-05-15 10:52:17 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-15 10:52:17 -0600 |
| commit | b2a699a47952323673a33951d9a6d94aff209831 (patch) | |
| tree | 076a7957344138d641400f4a97d8900c4456a57b /numpy | |
| parent | 32ac36eae7060a1e0246448b7ed2e3d72d49b780 (diff) | |
| parent | 7a01f661cef8fe492cbbf5ed1e2474c11ce0527b (diff) | |
| download | numpy-b2a699a47952323673a33951d9a6d94aff209831.tar.gz | |
Merge pull request #11094 from mattip/fix-11080
DOC: add numpy.lib.format to docs and link to it
Diffstat (limited to 'numpy')
| -rw-r--r-- | numpy/lib/format.py | 7 | ||||
| -rw-r--r-- | numpy/lib/npyio.py | 6 |
2 files changed, 6 insertions, 7 deletions
diff --git a/numpy/lib/format.py b/numpy/lib/format.py index a0ec55f01..23eac7e7d 100644 --- a/numpy/lib/format.py +++ b/numpy/lib/format.py @@ -1,9 +1,8 @@ """ +Binary serialization -.. _binary-serialization: - -Binary Serialization -==================== +NPY format +========== A simple format for saving numpy arrays to disk with the full information about them. diff --git a/numpy/lib/npyio.py b/numpy/lib/npyio.py index 95804be7f..b109d65e1 100644 --- a/numpy/lib/npyio.py +++ b/numpy/lib/npyio.py @@ -475,7 +475,7 @@ def save(file, arr, allow_pickle=True, fix_imports=True): Notes ----- - For a description of the ``.npy`` format, see :ref:`binary-serialization`. + For a description of the ``.npy`` format, see :py:mod:`numpy.lib.format`. Examples -------- @@ -559,7 +559,7 @@ def savez(file, *args, **kwds): The ``.npz`` file format is a zipped archive of files named after the variables they contain. The archive is not compressed and each file in the archive contains one variable in ``.npy`` format. For a - description of the ``.npy`` format, see :ref:`binary-serialization`. + description of the ``.npy`` format, see :py:mod:`numpy.lib.format`. When opening the saved ``.npz`` file with `load` a `NpzFile` object is returned. This is a dictionary-like object which can be queried for @@ -639,7 +639,7 @@ def savez_compressed(file, *args, **kwds): 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 - :ref:`binary-serialization`. + :py:mod:`numpy.lib.format`. When opening the saved ``.npz`` file with `load` a `NpzFile` object is |