docs: Examples

Author: kozistr

pytorch_optimizer/adamp.py

@@ -17,6 +17,17 @@
 class AdamP(Optimizer):
     """
     Reference : https://github.com/clovaai/AdamP/blob/master/adamp/adamp.py
+    Example :
+        from pytorch_optimizer import AdamP
+        ...
+        model = YourModel()
+        optimizer = AdaHessian(model.parameters())
+        ...
+        for input, output in data:
+          optimizer.zero_grad()
+          loss = loss_function(output, model(input))
+          loss.backward()
+          optimizer.step()
     """
 
     def __init__(

pytorch_optimizer/madgrad.py

@@ -14,6 +14,17 @@
 class MADGRAD(Optimizer):
     """
     Reference : https://github.com/facebookresearch/madgrad/blob/main/madgrad/madgrad.py
+    Example :
+        from pytorch_optimizer import MADGRAD
+        ...
+        model = YourModel()
+        optimizer = MADGRAD(model.parameters())
+        ...
+        for input, output in data:
+          optimizer.zero_grad()
+          loss = loss_function(output, model(input))
+          loss.backward()
+          optimizer.step()
     """
 
     def __init__(

pytorch_optimizer/radam.py

@@ -16,6 +16,17 @@
 class RAdam(Optimizer):
     """
     Reference : https://github.com/LiyuanLucasLiu/RAdam/blob/master/radam/radam.py#L5
+    Example :
+        from pytorch_optimizer import RAdam
+        ...
+        model = YourModel()
+        optimizer = RAdam(model.parameters())
+        ...
+        for input, output in data:
+          optimizer.zero_grad()
+          loss = loss_function(output, model(input))
+          loss.backward()
+          optimizer.step()
     """
 
     def __init__(

pytorch_optimizer/ranger.py

@@ -17,6 +17,17 @@
 class Ranger(Optimizer):
     """
     Reference : https://github.com/lessw2020/Ranger-Deep-Learning-Optimizer/blob/master/ranger/ranger.py
+    Example :
+        from pytorch_optimizer import Ranger
+        ...
+        model = YourModel()
+        optimizer = Ranger(model.parameters())
+        ...
+        for input, output in data:
+          optimizer.zero_grad()
+          loss = loss_function(output, model(input))
+          loss.backward()
+          optimizer.step()
     """
 
     def __init__(

pytorch_optimizer/ranger21.py

@@ -32,6 +32,17 @@
 class Ranger21(Optimizer):
     """
     Reference : https://github.com/lessw2020/Ranger21/blob/main/ranger21/ranger21.py
+    Example :
+        from pytorch_optimizer import Ranger21
+        ...
+        model = YourModel()
+        optimizer = Ranger21(model.parameters())
+        ...
+        for input, output in data:
+          optimizer.zero_grad()
+          loss = loss_function(output, model(input))
+          loss.backward()
+          optimizer.step()
     """
 
     def __init__(

pytorch_optimizer/sgdp.py

@@ -11,6 +11,17 @@
 class SGDP(Optimizer):
     """
     Reference : https://github.com/clovaai/AdamP/blob/master/adamp/sgdp.py
+    Example :
+        from pytorch_optimizer import SGDP
+        ...
+        model = YourModel()
+        optimizer = SGDP(model.parameters())
+        ...
+        for input, output in data:
+          optimizer.zero_grad()
+          loss = loss_function(output, model(input))
+          loss.backward()
+          optimizer.step()
     """
 
     def __init__(