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.10.0.tar.gz (1.5 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.10.0-py3-none-any.whl (131.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tmlt_analytics-0.10.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.7.17 Linux/5.15.154+

File hashes

Hashes for tmlt_analytics-0.10.0.tar.gz
Algorithm Hash digest
SHA256 a76278b4e5189945ad085ea178852d99b237c8e14ed719cef70092d4526ef26e
MD5 800606b4f5da800534ce409822475932
BLAKE2b-256 e1092c4f395ed81aa03eed41b320c3891124d0fe76733e340df8a98a5e010783

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmlt_analytics-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 131.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.7.17 Linux/5.15.154+

File hashes

Hashes for tmlt_analytics-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e23e2b1e8ccab9bf649a7f20174ee43088794252669d4efdbabe42d14688c497
MD5 380004d2e1a438e5bd83c1d4be8c2ddf
BLAKE2b-256 c96597154b382f2c4e8e70b2454c6b8e65286871f5ffff23d3d5166288bf495e

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