diff --git a/README.rst b/README.rst index 9fcadc32..3b837ed8 100644 --- a/README.rst +++ b/README.rst @@ -106,7 +106,7 @@ your Blosc build: .. code-block:: console - PYTHONPATH=. python bench/compress_numpy.py + PYTHONPATH=. python bench/pack_compress.py Just to whet your appetite, here are some speed figures for an Intel box (i9-10940X CPU @ 3.30GHz, 14 cores) running Ubuntu 22.04. In particular, see how performance for `pack_array2/unpack_array2` has diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 8ca8f35d..1b7c0aed 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -107,12 +107,18 @@ and `size`. * On the other hand, the function `unpack` doesn't return a numpy array whereas the `unpack_array` builds that array. + +* The `compcode` parameter has been renamed to `codec`. +A `NameError` exception will be raised when using the old name. +Please update your code when you see this exception. + +* The different codecs are accessible via the `Codec` enumerated. +E.g. `Codec.LZ4` or `Codec.Zlib` -* The `blosc.NOSHUFFLE` is replaced - by the `blosc2.NOFILTER`, but for backward - compatibility `blosc2.NOSHUFFLE` still exists. +* The different filters are accessible via the `Filter` enumerated. +E.g. `Filter.SHUFFLE` or `Filter.BITSHUFFLE` -* A bytearray or NumPy object can be passed to -the `blosc2.decompress` function to store the - decompressed data. +* The `blosc.NOSHUFFLE` is replaced by the `blosc2.Filter.NOFILTER`. +* A bytearray or NumPy object can be passed to the `blosc2.decompress` +function to store the decompressed data.