Skip to content

Commit

Permalink
remove members in combine, contrib, schedules, transformations
Browse files Browse the repository at this point in the history
  • Loading branch information
amosyou committed Feb 21, 2024
1 parent d44b905 commit 0bf3765
Show file tree
Hide file tree
Showing 4 changed files with 0 additions and 43 deletions.
1 change: 0 additions & 1 deletion docs/api/combining_optimizers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,3 @@ Multi-transform
~~~~~~~~~~~~~~~
.. autofunction:: multi_transform
.. autoclass:: MultiTransformState
:members:
15 changes: 0 additions & 15 deletions docs/api/contrib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
1 change: 0 additions & 1 deletion docs/api/optimizer_schedules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ Inject hyperparameters
~~~~~~~~~~~~~~~~~~~~~~
.. autofunction:: inject_hyperparams
.. autoclass:: InjectHyperparamsState
:members:

Linear schedules
~~~~~~~~~~~~~~~~
Expand Down
26 changes: 0 additions & 26 deletions docs/api/transformations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -136,64 +132,51 @@ 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

.. autofunction:: identity

.. 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

Expand All @@ -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

Expand All @@ -240,7 +216,6 @@ Transformations and states

.. autofunction:: trace
.. autoclass:: TraceState
:members:

.. autofunction:: update_infinity_moment
.. autofunction:: update_moment
Expand All @@ -250,4 +225,3 @@ Transformations and states

.. autofunction:: zero_nans
.. autoclass:: ZeroNansState
:members:

0 comments on commit 0bf3765

Please sign in to comment.