Simplifications on the doc

* Remove empty adjectives like "Common" or "Optax" from title * Merge the very small file privacy_sensitive.rst into utilities.rst PiperOrigin-RevId: 600386918
google-deepmind · Jan 22, 2024 · ed5c793 · ed5c793
1 parent d6fc6ae
commit ed5c793
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 24 deletions.
diff --git a/docs/api/common_losses.rst → docs/api/losses.rst b/docs/api/common_losses.rst → docs/api/losses.rst
@@ -1,5 +1,5 @@
-Common Losses
-===============
+Losses
+======
 
 .. currentmodule:: optax
 

diff --git a/docs/api/common_optimizers.rst → docs/api/optimizers.rst b/docs/api/common_optimizers.rst → docs/api/optimizers.rst
@@ -1,5 +1,5 @@
-Common Optimizers
-===================
+Optimizers
+==========
 
 .. currentmodule:: optax
 

diff --git a/docs/api/privacy_sensitive.rst b/docs/api/privacy_sensitive.rst
diff --git a/docs/api/optax_transformations.rst → docs/api/transformations.rst b/docs/api/optax_transformations.rst → docs/api/transformations.rst
@@ -1,4 +1,4 @@
-Optax Transformations
+Transformations
 =====================
 
 .. currentmodule:: optax

diff --git a/docs/api/utilities.rst b/docs/api/utilities.rst
@@ -37,6 +37,23 @@ Safe root mean squares
 .. autofunction:: safe_root_mean_squares
 
 
+Privacy-Sensitive Optax Methods
+-------------------------------
+
+.. currentmodule:: optax
+
+.. autosummary::
+    DifferentiallyPrivateAggregateState
+    differentially_private_aggregate
+
+
+Differentially Private Aggregate
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autofunction:: differentially_private_aggregate
+.. autoclass:: DifferentiallyPrivateAggregateState
+   :members:
+
+
 Second Order Optimization
 -------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -64,20 +64,20 @@ for instructions on installing JAX.
    :caption: API Documentation
    :maxdepth: 2
 
-   api/common_optimizers
-   api/optax_transformations
+   api/optimizers
+   api/transformations
    api/combining_optimizers
    api/optimizer_wrappers
    api/optimizer_schedules
    api/apply_updates
-   api/common_losses
+   api/losses
    api/linear_algebra_operators
    api/control_variates
    api/stochastic_gradient_estimators
-   api/privacy_sensitive
    api/utilities
    api/contrib
 
+
 The Team
 --------