Skip to main content

Tumult's differential privacy analytics API

Project description

PyPI - Version | Documentation - Latest | Join our Slack!

Tumult Analytics

Tumult Analytics is a library that allows users to execute differentially private operations on data without having to worry about the privacy implementation, which is handled automatically by the API. It is built atop the Tumult Core library.

Demo video

Want to see Tumult Analytics in action? Check out this video introducing the interface fundamentals:

Screenshot of the demo video

A selection of more advanced features is shown on the second part of this demo, in a separate video.

Installation

See the installation instructions in the documentation for information about setting up prerequisites such as Spark.

Once the prerequisites are installed, you can install Tumult Analytics using pip.

pip install tmlt.analytics

Documentation

The full documentation is located at https://docs.tmlt.dev/analytics/latest/.

Support

If you have any questions, feedback, or feature requests, please reach out to us on Slack.

Contributing

We do not yet have a process in place to accept external contributions, but we are open to collaboration opportunities. If you are interested in contributing, please let us know via Slack.

See CONTRIBUTING.md for information about installing our development dependencies and running tests.

Citing Tumult Analytics

If you use Tumult Analytics for a scientific publication, we would appreciate citations to the published software or/and its whitepaper. Both citations can be found below; for the software citation, please replace the version with the version you are using.

@software{tumultanalyticssoftware,
    author = {Tumult Labs},
    title = {Tumult {{Analytics}}},
    month = dec,
    year = 2022,
    version = {latest},
    url = {https://tmlt.dev}
}
@article{tumultanalyticswhitepaper,
  title={Tumult {{Analytics}}: a robust, easy-to-use, scalable, and expressive framework for differential privacy},
  author={Berghel, Skye and Bohannon, Philip and Desfontaines, Damien and Estes, Charles and Haney, Sam and Hartman, Luke and Hay, Michael and Machanavajjhala, Ashwin and Magerlein, Tom and Miklau, Gerome and Pai, Amritha and Sexton, William and Shrestha, Ruchit},
  journal={arXiv preprint arXiv:2212.04133},
  month = dec,
  year={2022}
}

License

Copyright Tumult Labs 2024

Tumult Analytics' source code is licensed under the Apache License, version 2.0 (Apache-2.0). Tumult Analytics' documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC-BY-SA-4.0).

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

tmlt_analytics-0.18.0.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

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

tmlt_analytics-0.18.0-py3-none-any.whl (142.4 kB view details)

Uploaded Python 3

File details

Details for the file tmlt_analytics-0.18.0.tar.gz.

File metadata

  • Download URL: tmlt_analytics-0.18.0.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.20 Linux/5.15.154+

File hashes

Hashes for tmlt_analytics-0.18.0.tar.gz
Algorithm Hash digest
SHA256 8586f6975f58033b4c1db728f5011a98a79519dc23f10dea7a5501dbfcfce238
MD5 b5b062a673ede7ea5b04f6315b19c489
BLAKE2b-256 8067b99d6db739c6eb024710af93b870058337211002e8faccca341e7db0381a

See more details on using hashes here.

File details

Details for the file tmlt_analytics-0.18.0-py3-none-any.whl.

File metadata

  • Download URL: tmlt_analytics-0.18.0-py3-none-any.whl
  • Upload date:
  • Size: 142.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.8.20 Linux/5.15.154+

File hashes

Hashes for tmlt_analytics-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bef8caa0d6bad1ee6010d235198e5b83712ae776fd313b7b952609d3e22aeed8
MD5 bfffb2836468c7a2fb54216aa8d3c022
BLAKE2b-256 7fe1c87aa80f923bc7ca311e34f3eaf430eb995fae1af302f638f26b5ac1ce2e

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