Metadata-Version: 2.1
Name: opendp-pytorch
Version: 0.1.0
Summary: PyTorch integration for the OpenDP Library
Home-page: https://opendp.org
Author: The OpenDP Project
Author-email: info@opendp.org
License: UNKNOWN
Project-URL: Source, https://github.com/opendp/opendp-pytorch
Project-URL: Issues, https://github.com/opendp/opendp-pytorch/issues
Project-URL: Documentation, https://docs.opendp.org/
Keywords: differential privacy
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: opendp
Requires-Dist: torch
Requires-Dist: torchcsprng

# OpenDP-PyTorch
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue)](https://www.python.org/)
[![ci tests](https://github.com/opendp/opendp-pytorch/actions/workflows/smoke-test.yml/badge.svg)](https://github.com/opendp/opendp-pytorch/actions/workflows/smoke-test.yml?query=branch%3Amain)

OpenDP-PyTorch is an extension to the [OpenDP](https://github.com/opendp/opendp) library for 
differentially private training of pytorch neural networks.

OpenDP-PyTorch is part of the larger [OpenDP Project](https://opendp.org), a community effort to build trustworthy,
open source software tools for analysis of private data.

## Status

OpenDP-PyTorch is under development, and we expect to [release new versions](https://github.com/opendp/opendp/releases) frequently,
incorporating feedback and code contributions from the OpenDP Community.
This library is not ready to build privacy-sensitive applications.

> OpenDP, like all real-world software, has both known and unknown issues.
> If you intend to use OpenDP for a privacy-critical application, you should evaluate the impact of these issues on your use case.
>
> More details can be found in the [Limitations section of the User Guide](https://docs.opendp.org/en/stable/user/limitations.html).


## Installation

The easiest way to install OpenDP-PyTorch is using `pip` (the [package installer for Python](https://pypi.org/project/pip/)):

    $ pip install opendp-pytorch

More information can be found in the [Getting Started section of the User Guide](https://docs.opendp.org/en/stable/user/getting-started.html).

## Documentation

Documentation is not yet available for the PyTorch extension.

## Getting Help

If you're having problems using OpenDP, or want to submit feedback, please reach out! Here are some ways to contact us:

* Ask questions on our [discussions forum](https://github.com/opendp/opendp/discussions)
* Open issues on our [issue tracker](https://github.com/opendp/opendp/issues)
* Send general queries to [info@opendp.org](mailto:info@opendp.org)
* Reach us on Twitter at [@opendp_org](https://twitter.com/opendp_org)

## Contributing

OpenDP is a community effort, and we welcome your contributions to its development!
If you'd like to participate, please see the [Contributing section of the Developer Guide](https://docs.opendp.org/en/stable/developer/intro.html)


