# opendp-pytorch

**Repository Path**: boilingolf/opendp-pytorch

## Basic Information

- **Project Name**: opendp-pytorch
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-20
- **Last Updated**: 2021-12-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 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)