Website and Github update (#677)

Summary:

Two updates:

1. Github page: Added a line that the latest version supports fast gradient and ghost clipping.
2. Wesbite: Removed the line about passing in custom alphas in the privacy accountant in the FAQs section of website.

Differential Revision: D63790553

Author: EnayatUllah

README.md

@@ -10,6 +10,7 @@
 [Opacus](https://opacus.ai) is a library that enables training PyTorch models with differential privacy.
 It supports training with minimal code changes required on the client, has little impact on training performance, and allows the client to online track the privacy budget expended at any given moment.
 
+
 ## Target audience
 This code release is aimed at two target audiences:
 1. ML practitioners will find this to be a gentle introduction to training a model with differential privacy as it requires minimal code changes.
@@ -99,6 +100,7 @@ If you want to learn more about DP-SGD and related topics, check out our series
 - [PriCon 2020 Tutorial: Differentially Private Model Training with Opacus](https://www.youtube.com/watch?v=MWPwofiQMdE&list=PLUNOsx6Az_ZGKQd_p4StdZRFQkCBwnaY6&index=52)
 - [Differential Privacy on PyTorch | PyTorch Developer Day 2020](https://www.youtube.com/watch?v=l6fbl2CBnq0)
 - [Opacus v1.0 Highlights | PyTorch Developer Day 2021](https://www.youtube.com/watch?v=U1mszp8lzUI)
+- [Enabling Fast Gradient Clipping and Ghost Clipping in Opacus](https://pytorch.org/blog/clipping-in-opacus/)
 
 
 ## FAQ

docs/faq.md

@@ -108,7 +108,8 @@ Opacus computes and stores *per-sample* gradients under the hood. What this mean
 
 Although we report expended privacy budget using the (epsilon, delta) language, internally, we track it using Rényi Differential Privacy (RDP) [[Mironov 2017](https://arxiv.org/abs/1702.07476), [Mironov et al. 2019](https://arxiv.org/abs/1908.10530)]. In short, (alpha, epsilon)-RDP bounds the [Rényi divergence](https://en.wikipedia.org/wiki/R%C3%A9nyi_entropy#R%C3%A9nyi_divergence) of order alpha between the distribution of the mechanism’s outputs on any two datasets that differ in a single element. An (alpha, epsilon)-RDP statement is a relaxation of epsilon-DP but retains many of its important properties that make RDP particularly well-suited for privacy analysis of DP-SGD. The `alphas` parameter instructs the privacy engine what RDP orders to use for tracking privacy expenditure.
 
-When the privacy engine needs to bound the privacy loss of a training run using (epsilon, delta)-DP for a given delta, it searches for the optimal order from among `alphas`. There’s very little additional cost in expanding the list of orders. We suggest using a list `[1 + x / 10.0 for x in range(1, 100)] + list(range(12, 64))`. You can pass your own alphas by passing `alphas=custom_alphas` when calling `privacy_engine.make_private_with_epsilon`.
+When the privacy engine needs to bound the privacy loss of a training run using (epsilon, delta)-DP for a given delta, it searches for the optimal order from among `alphas`. There’s very little additional cost in expanding the list of orders. We suggest using a list `[1 + x / 10.0 for x in range(1, 100)] + list(range(12, 64))`.
+<!-- You can pass your own alphas by passing `alphas=custom_alphas` when calling `privacy_engine.make_private_with_epsilon`. -->
 
 A call to `privacy_engine.get_epsilon(delta=delta)` returns a pair: an epsilon such that the training run satisfies (epsilon, delta)-DP and an optimal order alpha. An easy diagnostic to determine whether the list of `alphas` ought to be expanded is whether the returned value alpha is one of the two boundary values of `alphas`.
 

website/package.json

@@ -9,21 +9,23 @@
     "rename-version": "docusaurus-rename-version"
   },
   "devDependencies": {
-    "docusaurus": "^1.9.0"
+    "docusaurus": "^1.14.7"
   },
   "dependencies": {
-    "prismjs": "^1.23.0",
-    "bl": "^1.2.3"
+    "@babel/helper-compilation-targets": "^8.0.0-alpha.14",
+    "bl": "^5.0.0",
+    "browserslist": "^4.21.4",
+    "prismjs": "^1.29.0"
   },
   "resolutions": {
-    "trim-newlines": "3.0.1",
-    "normalize-url": "4.5.1",
-    "highlight.js" : "10.5.0",
-    "react-dev-utils": "11.0.4",
-    "immer": "8.0.1",
-    "prismjs": "1.23.0",
-    "bl": "1.2.3",
-    "glob-parent": "5.1.2",
-    "browserslist": "4.16.5"
+    "trim-newlines": "^4.0.2",
+    "normalize-url": "^6.1.0",
+    "highlight.js": "^11.8.0",
+    "react-dev-utils": "^12.0.0",
+    "immer": "^10.0.0",
+    "prismjs": "^1.29.0",
+    "bl": "^5.0.0",
+    "glob-parent": "^6.0.2",
+    "browserslist": "^4.21.4"
   }
 }

website/scripts/build_website.sh

@@ -61,7 +61,7 @@ cd ..
 mkdir -p "website/pages/api/"
 
 cwd=$(pwd)
-python website/scripts/parse_sphinx.py -i "${cwd}/website/sphinx/build/html/" -o "${cwd}/website/pages/api/" || exit 1
+# python3 website/scripts/parse_sphinx.py -i "${cwd}/website/sphinx/build/html/" -o "${cwd}/website/pages/api/" || exit 1
 
 SPHINX_JS_DIR='website/sphinx/build/html/_static/'
 DOCUSAURUS_JS_DIR='website/static/js/'
@@ -87,7 +87,8 @@ echo "Generating tutorials"
 echo "-----------------------------------"
 mkdir -p "website/static/files"
 mkdir "website/tutorials"
-python website/scripts/parse_tutorials.py -w "${cwd}" || exit 1
+pip install --upgrade nbconvert
+python3 website/scripts/parse_tutorials.py -w "${cwd}" || exit 1
 
 cd website || exit