Skip to main content

Squirrel is a Python library that enables ML teams to share, load, and transform data in a collaborative, flexible, and efficient way.

Project description

Squirrel Core

Share, load, and transform data in a collaborative, flexible, and efficient way

Python PyPI Conda Documentation Status Downloads License DOI Generic badge Slack


What is Squirrel?

Squirrel is a Python library that enables ML teams to share, load, and transform data in a collaborative, flexible, and efficient way.

  1. SPEED: Avoid data stall, i.e. the expensive GPU will not be idle while waiting for the data.

  2. COSTS: First, avoid GPU stalling, and second allow to shard & cluster your data and store & load it in bundles, decreasing the cost for your data bucket cloud storage.

  3. FLEXIBILITY: Work with a flexible standard data scheme which is adaptable to any setting, including multimodal data.

  4. COLLABORATION: Make it easier to share data & code between teams and projects in a self-service model.

Stream data from anywhere to your machine learning model as easy as:

it = (Catalog.from_plugins()["imagenet"].get_driver()
      .get_iter("train")
      .map(lambda r: (augment(r["image"]), r["label"]))
      .batched(100))

Check out our full getting started tutorial notebook. If you have any questions or would like to contribute, join our Slack community.

Installation

You can install squirrel-core by

pip install "squirrel-core[all]"

Documentation

Read our documentation at ReadTheDocs

Example Notebooks

Check out the Squirrel-datasets repository for open source and community-contributed tutorial and example notebooks of using Squirrel.

Contributing

Squirrel is open source and community contributions are welcome!

Check out the contribution guide to learn how to get involved.

The humans behind Squirrel

We are Merantix Momentum, a team of ~30 machine learning engineers, developing machine learning solutions for industry and research. Each project comes with its own challenges, data types and learnings, but one issue we always faced was scalable data loading, transforming and sharing. We were looking for a solution that would allow us to load the data in a fast and cost-efficient way, while keeping the flexibility to work with any possible dataset and integrate with any API. That's why we build Squirrel – and we hope you'll find it as useful as we do! By the way, we are hiring!

Citation

If you use Squirrel in your research, please cite it using:

@article{2022squirrelcore,
  title={Squirrel: A Python library that enables ML teams to share, load, and transform data in a collaborative, flexible, and efficient way.},
  author={Squirrel Developer Team},
  journal={GitHub. Note: https://github.com/merantix-momentum/squirrel-core},
  doi={10.5281/zenodo.6418280},
  year={2022}
}

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

squirrel-core-0.17.3.dev1331593.tar.gz (52.6 kB view details)

Uploaded Source

Built Distribution

squirrel_core-0.17.3.dev1331593-py3-none-any.whl (68.6 kB view details)

Uploaded Python 3

File details

Details for the file squirrel-core-0.17.3.dev1331593.tar.gz.

File metadata

File hashes

Hashes for squirrel-core-0.17.3.dev1331593.tar.gz
Algorithm Hash digest
SHA256 6f9e2060a65bc8d3fa080de4815750297396b1134b37063c755661d45c033a11
MD5 c89ba26dec7b894b38265c165091c711
BLAKE2b-256 4a1bb2606d5e08742dd8a93d1bd57103bd04d69cf3dfc179fea5ea51f61c9f66

See more details on using hashes here.

File details

Details for the file squirrel_core-0.17.3.dev1331593-py3-none-any.whl.

File metadata

File hashes

Hashes for squirrel_core-0.17.3.dev1331593-py3-none-any.whl
Algorithm Hash digest
SHA256 99e6a05fe72b8ccde6af781a064c7628aaeb41898430a3453fef1922c107d893
MD5 c9fb8f28ed4268d71cc420ffc0a9ce21
BLAKE2b-256 db364daf3ab90149a0c83f501a61dded2200e971569debd7d37e2cb9362b852b

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