pytorch / opacus

Training PyTorch models with differential privacy
https://opacus.ai
Apache License 2.0
1.65k stars 328 forks source link

Added GitHub citation file. #614

Open mainrs opened 7 months ago

mainrs commented 7 months ago

Types of changes

Motivation and Context / Related issue

GitHub introduces the citation file format to make it easier to discover and work with software that can be cited. Following the already provided citation inside the README, I created the corresponding citation file.

Similar to https://github.com/pytorch/pytorch, a new Cite this repository button will now be displayed on the right-hand side of the webpage inside the About section (see attached screenshot).

There are two things I'd like to point out:

  1. The citation type is now software instead of the original article. This can be changed using a preferred-citation key according to the official GitHub documentation.
  2. PyTorch has an organization attached to its citation. If this is applicable here too, then the file needs to be edited.

image

How Has This Been Tested (if it applies)

Checklist

facebook-github-bot commented 7 months ago

Hi @mainrs!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!