From ed5c7933e3d7754d5081688aca96bd55a6fe42f0 Mon Sep 17 00:00:00 2001 From: Fabian Pedregosa Date: Mon, 22 Jan 2024 01:48:49 -0800 Subject: [PATCH] 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 --- docs/api/{common_losses.rst => losses.rst} | 4 ++-- .../{common_optimizers.rst => optimizers.rst} | 4 ++-- docs/api/privacy_sensitive.rst | 15 --------------- ..._transformations.rst => transformations.rst} | 2 +- docs/api/utilities.rst | 17 +++++++++++++++++ docs/index.rst | 8 ++++---- 6 files changed, 26 insertions(+), 24 deletions(-) rename docs/api/{common_losses.rst => losses.rst} (98%) rename docs/api/{common_optimizers.rst => optimizers.rst} (96%) delete mode 100644 docs/api/privacy_sensitive.rst rename docs/api/{optax_transformations.rst => transformations.rst} (99%) diff --git a/docs/api/common_losses.rst b/docs/api/losses.rst similarity index 98% rename from docs/api/common_losses.rst rename to docs/api/losses.rst index 2737a89e8..31465076a 100644 --- a/docs/api/common_losses.rst +++ b/docs/api/losses.rst @@ -1,5 +1,5 @@ -Common Losses -=============== +Losses +====== .. currentmodule:: optax diff --git a/docs/api/common_optimizers.rst b/docs/api/optimizers.rst similarity index 96% rename from docs/api/common_optimizers.rst rename to docs/api/optimizers.rst index bcfc726e4..f88c26202 100644 --- a/docs/api/common_optimizers.rst +++ b/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 deleted file mode 100644 index 69b1b2d0d..000000000 --- a/docs/api/privacy_sensitive.rst +++ /dev/null @@ -1,15 +0,0 @@ -Privacy-Sensitive Optax Methods -================================== - -.. currentmodule:: optax - -.. autosummary:: - DifferentiallyPrivateAggregateState - differentially_private_aggregate - - -Differentially Private Aggregate -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. autofunction:: differentially_private_aggregate -.. autoclass:: DifferentiallyPrivateAggregateState - :members: diff --git a/docs/api/optax_transformations.rst b/docs/api/transformations.rst similarity index 99% rename from docs/api/optax_transformations.rst rename to docs/api/transformations.rst index 54bfb610d..383881fa0 100644 --- a/docs/api/optax_transformations.rst +++ b/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 index 2dcbef17e..e9a9ccf1f 100644 --- 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 index 7680c4f9b..a6e0fc9b7 100644 --- 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 --------