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.19.0.tar.gz (2.0 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.19.0-py3-none-any.whl (147.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tmlt_analytics-0.19.0.tar.gz
  • Upload date:
  • Size: 2.0 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.19.0.tar.gz
Algorithm Hash digest
SHA256 ef4fabe0ca68004545abf83b3e1010a07aba7d96019bb8586228fa2593cb5d71
MD5 f779e0114711e7645c41b01536fe5c65
BLAKE2b-256 b4113d52636d75eb733c614757382f24b76cfaae3031d50ead998b607b4dc8b8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmlt_analytics-0.19.0-py3-none-any.whl
  • Upload date:
  • Size: 147.0 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.19.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9dcdca426ba2b4ffc2e3a8fef0adc8a6d76707b2e28647eee64c22a8ae793ec5
MD5 02b66d1daebbaa91a3d126df49c6f39b
BLAKE2b-256 7f2994a7603d680feffc1d96e7b447c5ccf0429248e010a80380eb70c63fedd5

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