Merge pull request #41 from kozistr/feature/codecov

[CI] Add pytest & codecov

Author: kozistr

.github/workflows/ci.yml

@@ -15,24 +15,31 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Cache pip
+    - name: cache pip
       uses: actions/cache@v2
       with:
         path: ~/.cache/pip
         key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip-
           ${{ runner.os }}-
-    - name: Install dependencies
+    - name: install dependencies
+      run: pip install -r requirements-dev.txt
+    - name: check lint
+      run: make check
+    - name: check test
       run: |
-        pip install -r requirements-dev.txt
-    - name: Lint
-      run: |
-          make format
-    - name: Check Lint
-      run: |
-          make check
+        make test
+    - name: check codecov
+      uses: codecov/codecov-action@v2
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        directory: ./
+        files: ./coverage.xml
+        env_vars: OS,PYTHON
+        fail_ci_if_error: true
+        verbose: true

Makefile

@@ -1,16 +1,19 @@
-.PHONY: init format check build deploy requirements
+.PHONY: init format test check build deploy requirements
 
 init:
 	python3 -m pip install -U pipenv setuptools
 	python3 -m pipenv install --dev
 
 format:
-	isort --profile black -l 119 pytorch_optimizer setup.py lint.py
-	black -S -l 119 pytorch_optimizer setup.py lint.py
+	isort --profile black -l 119 pytorch_optimizer tests setup.py lint.py
+	black -S -l 119 pytorch_optimizer tests setup.py lint.py
+
+test:
+	python3 -m pytest -sv -vv --cov=pytorch_optimizer --cov-report=xml ./tests
 
 check:
-	isort --check-only --profile black -l 119 pytorch_optimizer setup.py lint.py
-	black -S -l 119 --check pytorch_optimizer setup.py lint.py
+	isort --check-only --profile black -l 119 pytorch_optimizer tests setup.py lint.py
+	black -S -l 119 --check pytorch_optimizer tests setup.py lint.py
 	python3 lint.py
 
 build:

Pipfile

@@ -7,6 +7,8 @@ verify_ssl = false
 isort = "==5.10.1"
 black = "==21.12b0"
 pylint = "==3.0.0a4"
+pytest = "==6.2.5"
+pytest-cov = "==3.0.0"
 
 [packages]
 numpy = "==1.21.4"

Pipfile.lock

@@ -1,7 +1,7 @@
 pytorch-optimizer
 =================
 
-| |workflow| |Documentation Status| |PyPI version| |PyPi download| |black|
+| |workflow| |codecov| |Documentation Status| |PyPI version| |PyPi download| |black|
 
 | Bunch of optimizer implementations in PyTorch with clean-code, strict types. Also, including useful optimization ideas.
 | Most of the implementations are based on the original paper, but I added some tweaks.
@@ -479,3 +479,5 @@ Hyeongchan Kim / `@kozistr <http://kozistr.tech/about>`__
    :target: https://badge.fury.io/py/pytorch-optimizer
 .. |PyPi download| image:: https://img.shields.io/pypi/dm/pytorch-optimizer?style=plastic
 .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+.. |codecov| image:: https://codecov.io/gh/kozistr/pytorch_optimizer/branch/main/graph/badge.svg?token=L4K00EA0VD
+   :target: https://codecov.io/gh/kozistr/pytorch_optimizer

README.rst

@@ -88,7 +88,7 @@ def check_valid_parameters(self):
             raise ValueError(f'Invalid beta_0 : {self.betas[0]}')
         if not 0.0 <= self.betas[1] < 1.0:
             raise ValueError(f'Invalid beta_1 : {self.betas[1]}')
-        if not 0.0 <= self.hessian_power < 1.0:
+        if not 0.0 <= self.hessian_power <= 1.0:
             raise ValueError(f'Invalid hessian_power : {self.hessian_power}')
         if self.eps < 0.0:
             raise ValueError(f'Invalid eps : {self.eps}')

pytorch_optimizer/adahessian.py

@@ -38,9 +38,9 @@ def __init__(
         gc_conv_only: bool = False,
         adamd_debias_term: bool = False,
     ):
-        """
+        """Ranger optimizer
         :param params: PARAMETERS. iterable of parameters to optimize or dicts defining parameter groups
-        :param lr: float. learning rate.
+        :param lr: float. learning rate
         :param betas: BETAS. coefficients used for computing running averages of gradient and the squared hessian trace
         :param weight_decay: float. weight decay (L2 penalty)
         :param n_sma_threshold: int. (recommended is 5)

pytorch_optimizer/ranger.py

@@ -11,16 +11,25 @@
 -i https://pypi.org/simple
 --trusted-host pypi.org
 astroid==2.6.6; python_version ~= '3.6'
+attrs==21.4.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
 black==21.12b0
 click==8.0.3; python_version >= '3.6'
+coverage[toml]==6.3; python_version >= '3.7'
+iniconfig==1.1.1
 isort==5.10.1
 lazy-object-proxy==1.7.1; python_version >= '3.6'
 mccabe==0.6.1
 mypy-extensions==0.4.3
 numpy==1.21.4
+packaging==21.3; python_version >= '3.6'
 pathspec==0.9.0
 platformdirs==2.4.1; python_version >= '3.7'
+pluggy==1.0.0; python_version >= '3.6'
+py==1.11.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4'
 pylint==3.0.0a4
+pyparsing==3.0.7; python_version >= '3.6'
+pytest-cov==3.0.0
+pytest==6.2.5
 setuptools==60.5.0; python_version >= '3.7'
 toml==0.10.2; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
 tomli==1.2.3; python_version >= '3.6'