docs: utils

Author: kozistr

docs/scheduler_api.rst

@@ -1,3 +1,145 @@
 # Utilization
 
+::: pytorch_optimizer.optimizer.utils.get_optimizer_parameters
+    :docstring:
+    :members:
 
+::: pytorch_optimizer.optimizer.utils.is_valid_parameters
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.has_overflow
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.to_real
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.normalize_gradient
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.flatten_grad
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.un_flatten_grad
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.channel_view
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.layer_view
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.cosine_similarity_by_view
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.clip_grad_norm
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.projection
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.unit_norm
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.neuron_norm
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.neuron_mean
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.disable_running_stats
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.enable_running_stats
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.l2_projection
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.get_global_gradient_norm
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.utils.reduce_max_except_dim
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.merge_small_dims
+    :docstring:
+    :members:
+
+## Newton methods
+
+::: pytorch_optimizer.optimizer.shampoo_utils.power_iteration
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.compute_power_schur_newton
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.compute_power_svd
+    :docstring:
+    :members:
+
+## Grafting
+
+::: pytorch_optimizer.optimizer.shampoo_utils.Graft
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.LayerWiseGrafting
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.SGDGraft
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.SQRTNGraft
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.AdaGradGraft
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.RMSPropGraft
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.build_graft
+    :docstring:
+    :members:
+
+## Block Partitioner
+
+::: pytorch_optimizer.optimizer.shampoo_utils.BlockPartitioner
+    :docstring:
+    :members:
+
+## Pre-Conditioner
+
+::: pytorch_optimizer.optimizer.shampoo_utils.PreConditionerType
+    :docstring:
+    :members:
+
+::: pytorch_optimizer.optimizer.shampoo_utils.PreConditioner
+    :docstring:
+    :members: