Deprecate RAdam optimizer properly. (#389)

Author: jettify

CHANGES.rst

@@ -1,6 +1,10 @@
 Changes
 -------
 
+0.3.1 (YYYY-MM-DD)
+------------------
+* Deprecate RAdam optimizer.
+
 0.3.0 (2021-10-30)
 ------------------
 * Revert for Drop RAdam.

README.rst

@@ -775,6 +775,8 @@ RAdam
 | .. image:: https://raw.githubusercontent.com/jettify/pytorch-optimizer/master/docs/rastrigin_RAdam.png  |  .. image:: https://raw.githubusercontent.com/jettify/pytorch-optimizer/master/docs/rosenbrock_RAdam.png  |
 +---------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+
 
+Deprecated, please use version provided by PyTorch_.
+
 .. code:: python
 
     import torch_optimizer as optim

torch_optimizer/__init__.py

@@ -79,7 +79,7 @@
     # utils
     'get',
 )
-__version__ = '0.3.0'
+__version__ = '0.3.1a0'
 
 
 _package_opts = [

torch_optimizer/radam.py

@@ -1,4 +1,5 @@
 import math
+import warnings
 
 import torch
 from torch.optim.optimizer import Optimizer
@@ -11,6 +12,9 @@
 class RAdam(Optimizer):
     r"""Implements RAdam optimization algorithm.
 
+    Note:
+        Deprecated, please use version provided by PyTorch_.
+
     It has been proposed in `On the Variance of the Adaptive Learning
     Rate and Beyond`__.
 
@@ -45,6 +49,12 @@ def __init__(
         eps: float = 1e-8,
         weight_decay: float = 0,
     ) -> None:
+        warnings.warn(
+            'RAdam optimizer is deprecated, since it is included '
+            'in pytorch natively.',
+            DeprecationWarning,
+            stacklevel=2,
+        )
         if lr <= 0.0:
             raise ValueError('Invalid learning rate: {}'.format(lr))
         if eps < 0.0: