| Utilities |
| ========= |
|
|
| General |
| ------- |
|
|
| .. currentmodule:: optax |
|
|
| .. autosummary:: |
| scale_gradient |
| value_and_grad_from_state |
|
|
| Scale gradient |
| ~~~~~~~~~~~~~~ |
| .. autofunction:: scale_gradient |
|
|
| Value and grad from state |
| ~~~~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: value_and_grad_from_state |
|
|
|
|
| Numerical Stability |
| ------------------- |
|
|
| .. currentmodule:: optax |
|
|
| .. autosummary:: |
| safe_int32_increment |
| safe_norm |
| safe_root_mean_squares |
|
|
| Safe int32 increment |
| ~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: safe_int32_increment |
|
|
| Safe norm |
| ~~~~~~~~~ |
| .. autofunction:: safe_norm |
|
|
| Safe root mean squares |
| ~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: safe_root_mean_squares |
|
|
|
|
| Linear Algebra Operators |
| ------------------------ |
|
|
| .. currentmodule:: optax |
|
|
| .. autosummary:: |
| matrix_inverse_pth_root |
| multi_normal |
| power_iteration |
|
|
|
|
| Multi normal |
| ~~~~~~~~~~~~ |
| .. autofunction:: multi_normal |
|
|
| Matrix inverse pth root |
| ~~~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: matrix_inverse_pth_root |
|
|
| Power iteration |
| ~~~~~~~~~~~~~~~ |
| .. autofunction:: power_iteration |
|
|
|
|
| Second Order Optimization |
| ------------------------- |
|
|
| .. currentmodule:: optax.second_order |
|
|
| .. autosummary:: |
| fisher_diag |
| hessian_diag |
| hvp |
|
|
| Fisher diagonal |
| ~~~~~~~~~~~~~~~ |
| .. autofunction:: fisher_diag |
|
|
| Hessian diagonal |
| ~~~~~~~~~~~~~~~~ |
| .. autofunction:: hessian_diag |
|
|
| Hessian vector product |
| ~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: hvp |
|
|
|
|
| Tree |
| ---- |
|
|
| .. currentmodule:: optax.tree_utils |
|
|
| .. autosummary:: |
| NamedTupleKey |
| tree_add |
| tree_add_scalar_mul |
| tree_div |
| tree_get |
| tree_get_all_with_path |
| tree_l1_norm |
| tree_l2_norm |
| tree_map_params |
| tree_mul |
| tree_ones_like |
| tree_random_like |
| tree_scalar_mul |
| tree_set |
| tree_sub |
| tree_sum |
| tree_vdot |
| tree_zeros_like |
|
|
| NamedTupleKey |
| ~~~~~~~~~~~~~ |
| .. autoclass:: NamedTupleKey |
|
|
| Tree add |
| ~~~~~~~~ |
| .. autofunction:: tree_add |
|
|
| Tree add and scalar multiply |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_add_scalar_mul |
|
|
| Tree divide |
| ~~~~~~~~~~~ |
| .. autofunction:: tree_div |
|
|
| Fetch single value that match a given key |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_get |
|
|
| Fetch all values that match a given key |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_get_all_with_path |
|
|
| Tree l1 norm |
| ~~~~~~~~~~~~ |
| .. autofunction:: tree_l1_norm |
|
|
| Tree l2 norm |
| ~~~~~~~~~~~~ |
| .. autofunction:: tree_l2_norm |
|
|
| Tree map parameters |
| ~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_map_params |
|
|
| Tree multiply |
| ~~~~~~~~~~~~~ |
| .. autofunction:: tree_mul |
|
|
| Tree ones like |
| ~~~~~~~~~~~~~~ |
| .. autofunction:: tree_ones_like |
|
|
| Tree with random values |
| ~~~~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_random_like |
|
|
| Tree scalar multiply |
| ~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_scalar_mul |
|
|
| Set values in a tree |
| ~~~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_set |
|
|
| Tree subtract |
| ~~~~~~~~~~~~~ |
| .. autofunction:: tree_sub |
|
|
| Tree sum |
| ~~~~~~~~ |
| .. autofunction:: tree_sum |
|
|
| Tree inner product |
| ~~~~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_vdot |
|
|
| Tree zeros like |
| ~~~~~~~~~~~~~~~ |
| .. autofunction:: tree_zeros_like |
|
|
