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.15.0.dev70272.tar.gz (52.1 kB view details)

Uploaded Source

Built Distribution

squirrel_core-0.15.0.dev70272-py3-none-any.whl (68.0 kB view details)

Uploaded Python 3

File details

Details for the file squirrel-core-0.15.0.dev70272.tar.gz.

File metadata

File hashes

Hashes for squirrel-core-0.15.0.dev70272.tar.gz
Algorithm Hash digest
SHA256 c264e5915e78916ef88b2a43e5daf2d4ed999e203e18b9371151b55269d11cb4
MD5 f2ec335c128f30f29e8b77203bd54694
BLAKE2b-256 a934dcafc711528a29bce6002155fc2e635ffd0a3022a9953ae44cff0b44e393

See more details on using hashes here.

File details

Details for the file squirrel_core-0.15.0.dev70272-py3-none-any.whl.

File metadata

File hashes

Hashes for squirrel_core-0.15.0.dev70272-py3-none-any.whl
Algorithm Hash digest
SHA256 db1c2d68242d06ad460bf443daa492927cb070427fdc256c8ebdbccb966e7256
MD5 fa726ecf2a6b7451fe0eaa9c0c598d23
BLAKE2b-256 af8b43ac90f0ba0e6d8d4045b21831c511c606ff47f6a7f4078e6295a957bd4e

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