docs: usage

kozistr · Nov 15, 2021 · c92f236 · c92f236
1 parent 4ee7d25
commit c92f236
Showing 1 changed file with 13 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -27,18 +27,24 @@ Simple Usage
 
 ::
 
-    from pytorch_optimizer import Ranger21
+    from pytorch_optimizer import AdamP
 
     ...
     model = YourModel()
-    optimizer = Ranger21(model.parameters())
+    optimizer = AdamP(model.parameters())
     ...
 
-    for input, output in data:
-      optimizer.zero_grad()
-      loss = loss_function(output, model(input))
-      loss.backward()
-      optimizer.step()
+or you can use optimizer loader, simply passing a name of the optimizer.
+
+::
+
+    from pytorch_optimizer import load_optimizers
+
+    ...
+    model = YourModel()
+    opt = load_optimizers(optimizer='adamp', use_fp16=True)
+    optimizer = opt(model.parameters())
+    ...
 
 Supported Optimizers
 --------------------