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.1.dev681.tar.gz (52.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

squirrel_core-0.17.1.dev681-py3-none-any.whl (68.5 kB view details)

Uploaded Python 3

File details

Details for the file squirrel-core-0.17.1.dev681.tar.gz.

File metadata

  • Download URL: squirrel-core-0.17.1.dev681.tar.gz
  • Upload date:
  • Size: 52.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for squirrel-core-0.17.1.dev681.tar.gz
Algorithm Hash digest
SHA256 ed9a220281f3ecd9249bf942ee9abe67bec4b34e95411956c5f1b01f683bf5f8
MD5 b1c8331ebf81a5ee01618f23f230411b
BLAKE2b-256 02d81d1831821184df1f7734a3d0dc465ac70bf90206a52f28098e2d78774611

See more details on using hashes here.

File details

Details for the file squirrel_core-0.17.1.dev681-py3-none-any.whl.

File metadata

File hashes

Hashes for squirrel_core-0.17.1.dev681-py3-none-any.whl
Algorithm Hash digest
SHA256 ae4ca0209472faa14067a6183f40855af9b00612529e7acf7e6aaea90f59bfe5
MD5 52ac2f23b01493c8d5faf817bea2a35f
BLAKE2b-256 84142609711385a84fe6d4d68ef5ab89d3ba98977952a3f6573042c3bf0c5f3a

See more details on using hashes here.

Supported by

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