Skip to content

RELEASE_NOTES.md

Latest commit

 

History

History
306 lines (163 loc) · 10.4 KB

RELEASE_NOTES.md

File metadata and controls

306 lines (163 loc) · 10.4 KB

Release notes

Changes from 2.2.6 to 2.2.7

XXX version-specific blurb XXX

Changes from 2.2.5 to 2.2.6

  • Multithreading checks only apply to Python defined codecs and filters. Now it is possible to use multithreading with C codecs and filters plugins. See PR #127.

  • New support for dynamic filters registry for Python.

  • Now params for codec and filter plugins are correctly initialized when using register_codec and register_filter functions.

  • Some fixes for Cython 3.0.0. However,compatibility with Cython 3.0.0 is not here yet, so build and install scripts are still requiring Cython<3.

  • Updated to latest C-Blosc2 2.10.1.

Changes from 2.2.4 to 2.2.5

  • Updated to latest C-Blosc2 2.10.0.

  • Use the new, fixed bytedelta filter introduced in C-Blosc2 2.10.0.

  • Some small fixes in tutorials.

Changes from 2.2.2 to 2.2.4

  • Added a new section of tutorials for a quick get start.

  • Added a new section on how to cite Blosc.

  • New method interchunks_info for SChunk and NDArray classes. This iterates through chunks for getting meta info, like decompression ratio, whether the chunk is special or not, among others. For more information on how this works see this example.

  • Now it is possible to register a dynamic plugin by passing None as the encoder and decoder arguments in the register_codec function.

  • Make shape of scalar slices NDArray objects to follow NumPy conventions. See #117.

  • Updated to latest C-Blosc2 2.9.3.

Changes from 2.2.2 to 2.2.3

  • Updated to latest C-Blosc2 2.9.2.

  • Better GIL handling. Thanks to @martaiborra.

Changes from 2.2.1 to 2.2.2

  • Wheels are not including blosc2.pc (pkgconfig) anymore. For details see: Blosc#111 Thanks to @bnavigator for the PR.

Changes from 2.2.0 to 2.2.1

  • Updated to latest C-Blosc2 2.9.1.

Changes from 2.1.1 to 2.2.0

  • New bytedelta filter. We have blogged about this: https://www.blosc.org/posts/bytedelta-enhance-compression-toolset/. See the examples/ndarray/bytedelta_filter.py for a sample script. We also have a short video on how bytedelta works: https://www.youtube.com/watch?v=5OXs7w2x6nw

  • The compression defaults are changed to get a better balance between compression ratio, compression speed and decompression speed. The new defaults are:

    • cparams.typesize = 8
    • cparams.clevel = 1
    • cparams.compcode = Codec.ZSTD
    • filters = [Filter.SHUFFLE]
    • splitmode = SplitMode.ALWAYS_SPLIT

    These changes have been based on the mentioned blog post above.

  • dtype.itemsize will have preference over typesize in cparams (as it was documented).

  • blosc2.compressor_list(plugins=False) do not list codec plugins by default now. If you want to list plugins too, you need to pass plugins=True.

  • Internal C-Blosc2 updated to latest version (2.8.0).

Changes from 2.0.0 to 2.1.1

Changes from 0.6.6 to 2.0.0

  • Add support for user-defined filters and codecs.

Changes from 0.6.5 to 0.6.6

  • Add arm64 wheels for macosx (this time for real).

Changes from 0.6.4 to 0.6.5

  • Add arm64 wheels for macosx.

Changes from 0.6.3 to 0.6.4

  • Add arm64 wheels and remove musl builds (NumPy not having them makes the build process too long).

Changes from 0.6.2 to 0.6.3

  • Use oldest-supported-numpy for maximum compatibility.

Changes from 0.6.1 to 0.6.2

  • Updated C-Blosc2 to 2.6.0.

Changes from 0.5.2 to 0.6.1

  • Support for Python prefilters and postfilters. With this, you can pre-process or post-process data in super-chunks automatically. This machinery is handled internally by C-Blosc2, so it is very efficient (although it cannot work in multi-thread mode due to the GIL). See the examples/ directory for different ways of using this.

  • Support for fillers. This is a specialization of a prefilter, and it allows to use Python functions to create new super-chunks from different kind of inputs (NumPy, SChunk instances, scalars), allowing computations among them and getting the result automatically compressed. See a sample script in the examples/ directory.

  • Lots of small improvements in the style, consistency and other glitches in the code. Thanks to Dimitri Papadopoulos for hist attention to detail.

  • No need to compile C-Blosc2 tests, benchmarks or fuzzers. Compilation time is much shorter now.

  • Added cratio, nbytes and cbytes properties to SChunk instances.

  • Added setters for dparams and cparams attributes in SChunk.

Changes from 0.5.1 to 0.5.2

  • Honor nested cparams properties in kwargs.

  • C-Blosc2 upgraded to 2.4.3. It should improve cratio for BloscLZ in combination with bitshuffle.

  • Prefer pack_tensor/save_tensor in benchmarks and examples

Changes from 0.5.0 to 0.5.1

  • Remove the testing of packing PyTorch or TensorFlow objects during wheels build.

Changes from 0.4.1 to 0.5.0

  • New pack_tensor, unpack_tensor, save_tensor and load_tensor functions for serializing/deserializing PyTorch and TensorFlow tensor objects. They also understand NumPy arrays, so these are the new recommended ones for serialization.

  • pack_array2 do not modify the value of a possible cparams parameter anymore.

  • The pack_array2 / save_array have changed the serialization format to follow the new standard introduced in pack_tensor. In the future pack_array2 / save_array will probably be deprecated, so please change to pack_tensor / save_tensor as soon as you can.

  • The new 'standard' for serialization relies on using the 'pack_tensor' attribute as a vlmeta (variable length) metalayer.

Changes from 0.4.0 to 0.4.1

  • Add msgpack as a runtime requirement

Changes from 0.3.2 to 0.4.0

  • New pack_array2() and unpack_array2() functions for packing NumPy arrays. Contrarily to pack_array() and unpack_array() counterparts, the new ones allow for compressing arrays larger than 2 GB in size.

  • New SChunk.to_cframe() and blosc2.from_cframe() methods for serializing/deserializing SChunk instances.

  • New SChunk.get_slice(), SChunk.__getitem__() and SChunk.__setitem__() methods for getting/setting slices from/to SChunk instances.

  • 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.

  • More doc restructurings. Hopefully, they are more pleasant to read now :-)

Changes from 0.3.1 to 0.3.2

  • Several leaks fixed. Thanks to Christoph Gohlke.

  • Internal C-Blosc2 updated to 2.3.1

Changes from 0.3.0 to 0.3.1

  • Internal C-Blosc2 updated to 2.3.0

Changes from 0.2.0 to 0.3.0

  • Added a new blosc2.open(urlpath, mode) function to be able to open persisted super-chunks.

  • Added a new tutorial in notebook format (examples/tutorial-basics.ipynb) about the basics of python-blosc2.

  • Internal C-Blosc2 updated to 2.2.0

Changes from 0.1.10 to 0.2.0

  • Internal C-Blosc updated to 2.0.4.

Super-chunk implementation

  • New SChunk class that allows to create super-chunks. This includes the capability of storing data in 4 different ways (sparse/contiguous and in memory/on-disk), as well as storing variable length metalayers.

  • Also, during the construction of a SChunk instance, an arbitrarily large data buffer can be given so that it is automatically split in chunks and those are appended to the SChunk.

  • See examples/schunk.py and examples/vlmeta.py for some examples.

  • Documentation of the new API is here: https://www.blosc.org/python-blosc2/python-blosc2.html

This release is the result of a grant offered by the Python Software Foundation to Marta Iborra. A blog entry was written describing the difficulties and relevant aspects learned during the work: https://www.blosc.org/posts/python-blosc2-initial-release/

Changes from python-blosc2 0.1.9 to python-blosc2 0.1.10

  • Release with C-Blosc 2.0.2 sources and binaries.

Changes from python-blosc2 0.1.8 to python-blosc2 0.1.9

  • Release with C-Blosc 2.0.1 sources and binaries.

Changes from python-blosc2 0.1.7 to python-blosc2 0.1.8

  • New versions of Blosc2 library added: plugins and lite.

Changes from python-blosc2 0.1.5 to python-blosc2 0.1.7

  • Headers and binaries for the C-Blosc2 library are starting to being distributed inside wheels.

  • Internal C-Blosc2 submodule updated to 2.0.0-rc2.

  • Repeating measurements 4 times in benchmarks so as to get more consistent figures.

Changes from python-blosc2 0.1.1 to python-blosc2 0.1.5

  • Fix some issues with packaging. See: Blosc#9

Changes from python-blosc to python-blosc2

  • The functions compress_ptr and decompress_ptr are replaced by pack and unpack since Pickle protocol 5 comes with out-of-band data.

  • The function pack_array is equivalent to pack, which accepts any object with attributes itemsize 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 different filters are accessible via the Filter enumerated. E.g. Filter.SHUFFLE or Filter.BITSHUFFLE

  • 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.