From 0bf376529fc19c301c55737aebd91dcef11a4029 Mon Sep 17 00:00:00 2001 From: Amos You Date: Tue, 20 Feb 2024 19:40:04 -0800 Subject: [PATCH] remove members in combine, contrib, schedules, transformations --- docs/api/combining_optimizers.rst | 1 - docs/api/contrib.rst | 15 --------------- docs/api/optimizer_schedules.rst | 1 - docs/api/transformations.rst | 26 -------------------------- 4 files changed, 43 deletions(-) diff --git a/docs/api/combining_optimizers.rst b/docs/api/combining_optimizers.rst index 2651fd5f5..48ff3aa49 100644 --- a/docs/api/combining_optimizers.rst +++ b/docs/api/combining_optimizers.rst @@ -15,4 +15,3 @@ Multi-transform ~~~~~~~~~~~~~~~ .. autofunction:: multi_transform .. autoclass:: MultiTransformState - :members: diff --git a/docs/api/contrib.rst b/docs/api/contrib.rst index f0e2d1dd3..253e17e8a 100644 --- a/docs/api/contrib.rst +++ b/docs/api/contrib.rst @@ -27,47 +27,32 @@ Complex-valued Optimization ~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autofunction:: split_real_and_imaginary .. autoclass:: SplitRealAndImaginaryState - :members: Continuous coin betting ~~~~~~~~~~~~~~~~~~~~~~~ .. autofunction:: cocob .. autoclass:: COCOBState - :members: D-adaptation ~~~~~~~~~~~~ .. autofunction:: dadapt_adamw .. autoclass:: DAdaptAdamWState - :members: - -Privacy-Sensitive Optax Methods -------------------------------- - -.. autosummary:: - DifferentiallyPrivateAggregateState - differentially_private_aggregate - Differentially Private Aggregate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autofunction:: differentially_private_aggregate .. autoclass:: DifferentiallyPrivateAggregateState - :members: .. autofunction:: dpsgd - Mechanize ~~~~~~~~~ .. autofunction:: mechanize .. autoclass:: MechanicState - :members: Prodigy ~~~~~~~ .. autofunction:: prodigy .. autoclass:: ProdigyState - :members: Sharpness aware minimization ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/api/optimizer_schedules.rst b/docs/api/optimizer_schedules.rst index 299c09b74..5d3867dc3 100644 --- a/docs/api/optimizer_schedules.rst +++ b/docs/api/optimizer_schedules.rst @@ -46,7 +46,6 @@ Inject hyperparameters ~~~~~~~~~~~~~~~~~~~~~~ .. autofunction:: inject_hyperparams .. autoclass:: InjectHyperparamsState - :members: Linear schedules ~~~~~~~~~~~~~~~~ diff --git a/docs/api/transformations.rst b/docs/api/transformations.rst index 5ca5289f1..30f35116d 100644 --- a/docs/api/transformations.rst +++ b/docs/api/transformations.rst @@ -115,19 +115,15 @@ Transformations and states .. autofunction:: adaptive_grad_clip .. autoclass:: AdaptiveGradClipState - :members: .. autofunction:: add_decayed_weights .. autoclass:: AddDecayedWeightsState - :members: .. autofunction:: add_noise .. autoclass:: AddNoiseState - :members: .. autofunction:: apply_every .. autoclass:: ApplyEvery - :members: .. autofunction:: bias_correction @@ -136,18 +132,14 @@ Transformations and states .. autofunction:: clip .. autofunction:: clip_by_block_rms .. autoclass:: ClipState - :members: .. autofunction:: clip_by_global_norm .. autoclass:: ClipByGlobalNormState - :members: .. autofunction:: ema .. autoclass:: EmaState - :members: .. autoclass:: EmptyState - :members: .. autofunction:: global_norm @@ -155,45 +147,36 @@ Transformations and states .. autofunction:: keep_params_nonnegative .. autoclass:: NonNegativeParamsState - :members: .. autofunction:: per_example_global_norm_clip .. autofunction:: per_example_layer_norm_clip .. autofunction:: scale .. autoclass:: ScaleState - :members: .. autofunction:: scale_by_adadelta .. autoclass:: ScaleByAdaDeltaState - :members: .. autofunction:: scale_by_adam .. autofunction:: scale_by_adamax .. autoclass:: ScaleByAdamState - :members: .. autofunction:: scale_by_amsgrad .. autoclass:: ScaleByAmsgradState - :members: .. autofunction:: scale_by_belief .. autoclass:: ScaleByBeliefState - :members: .. autofunction:: scale_by_factored_rms .. autoclass:: FactoredState - :members: .. autofunction:: scale_by_learning_rate .. autofunction:: scale_by_lion .. autoclass:: ScaleByLionState - :members: .. autofunction:: scale_by_novograd .. autoclass:: ScaleByNovogradState - :members: .. autofunction:: scale_by_optimistic_gradient @@ -205,31 +188,24 @@ Transformations and states .. autofunction:: scale_by_rms .. autoclass:: ScaleByRmsState - :members: .. autofunction:: scale_by_rprop .. autoclass:: ScaleByRpropState - :members: .. autofunction:: scale_by_rss .. autoclass:: ScaleByRssState - :members: .. autofunction:: scale_by_schedule .. autoclass:: ScaleByScheduleState - :members: .. autofunction:: scale_by_sm3 .. autoclass:: ScaleBySM3State - :members: .. autofunction:: scale_by_stddev .. autoclass:: ScaleByRStdDevState - :members: .. autofunction:: scale_by_trust_ratio .. autoclass:: ScaleByTrustRatioState - :members: .. autofunction:: scale_by_yogi @@ -240,7 +216,6 @@ Transformations and states .. autofunction:: trace .. autoclass:: TraceState - :members: .. autofunction:: update_infinity_moment .. autofunction:: update_moment @@ -250,4 +225,3 @@ Transformations and states .. autofunction:: zero_nans .. autoclass:: ZeroNansState - :members: