Skip to main content

Optimized format for pickling binary data.

Project description

BinPickle - efficient binary pickled data

PyPI version Test and Build codecov

This package uses the new Pickle Protocol 5 added in Python 3.8 to efficiently serialize large objects, particularly from scientific Python packages, to an on-disk format. This format is designed to support two use cases:

  1. Serializing data-intensive statistical models in a memory-mappable format so multiple processes can share the same (read-only) model memory.
  2. Serializing data-intensive statistical models with good compression for long-term storage and cross-machine transportation.

BinPickle does this by using Pickle 5's out-of-band buffer serialization support to write buffers uncompressed and page-aligned for memory mapping (use case 1) or with per-buffer efficient compression with libraries like Blosc (use case 2).

Format Stability

We do not yet guarantee the stability of the BinPickle format. We will avoid gratuitous changes, but BinPickle 1.0 will be the first with a stability guarantee.

Acknowledgements

This material is based upon work supported by the National Science Foundation under Grant No. IIS 17-51278. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation. This page has not been approved by Boise State University and does not reflect official university positions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

binpickle-0.4.0a1.tar.gz (21.6 kB view details)

Uploaded Source

Built Distribution

binpickle-0.4.0a1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file binpickle-0.4.0a1.tar.gz.

File metadata

  • Download URL: binpickle-0.4.0a1.tar.gz
  • Upload date:
  • Size: 21.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for binpickle-0.4.0a1.tar.gz
Algorithm Hash digest
SHA256 818b6b7ee429f61c41a4fa4a0de7c42642caac1ef5e27387124c8a632d86bd27
MD5 91f832780f94f3a6d2201cd26ef83296
BLAKE2b-256 93c748b00638f5675aa066b3ebd120e304739260ac058b8f0929ee9ce1fecf0e

See more details on using hashes here.

File details

Details for the file binpickle-0.4.0a1-py3-none-any.whl.

File metadata

  • Download URL: binpickle-0.4.0a1-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for binpickle-0.4.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc5d65067a2acb072c593fafca237d4c8b8f54a765c97e8e62a2dce4c5b6287b
MD5 ab13c7de200775a19f1bfcb103e39ae3
BLAKE2b-256 e0fb18834a660a3297c95f72eac7a6bf9c21b416b14914100c9e73768d6b3756

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page