Checking for requires_grad

.deepsource.toml

@@ -0,0 +1,17 @@
+version = 1
+
+test_patterns = ["tests/test_*.py"]
+
+exclude_patterns = [
+    "tests/test_optimizer.py",
+    "docs/conf.py",
+    "tests/utils.py",
+    "examples/*"
+]
+
+[[analyzers]]
+name = "python"
+enabled = true
+
+  [analyzers.meta]
+  runtime_version = "3.x.x"

.github/dependabot.yml

@@ -0,0 +1,21 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: weekly
+    day: "monday"
+    time: "10:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: numpy
+    versions:
+    - 1.20.0
+    - 1.20.1
+  - dependency-name: isort
+    versions:
+    - 5.7.0
+  - dependency-name: ipython
+    versions:
+    - 7.19.0
+    - 7.20.0

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '39 10 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/python-package.yml

@@ -0,0 +1,71 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+    tags: [ 'v*' ]
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron:  '0 6 * * 1'  # Weekly Mon 6AM UTC build
+
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.7', '3.8', '3.9']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install codecov
+        pip install -r requirements-dev.txt
+    - name: Lint
+      run: |
+          make lint
+          make checkbuild
+
+    - name: Test
+      run: |
+        make cov
+        codecov
+
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    needs: test
+    # Run only on pushing a tag
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+    - name: Setup Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - name: Install dependencies
+      run:
+        python -m pip install -U pip wheel twine
+    - name: Make dists
+      run:
+        python setup.py sdist bdist_wheel
+    - name: PyPI upload
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        twine upload dist/*

.gitignore

@@ -60,3 +60,7 @@ target/
 .coverage.*
 coverage
 .mypy_cache/
+.DS_Store
+tags
+cscope.*
+TODO

CHANGES.rst

@@ -1,6 +1,25 @@
 Changes
 -------
 
-0.0.1 (YYYY-MM-DD)
+0.3.1 (YYYY-MM-DD)
+------------------
+* Deprecate RAdam optimizer.
+
+0.3.0 (2021-10-30)
+------------------
+* Revert for Drop RAdam.
+
+0.2.0 (2021-10-25)
+------------------
+* Drop RAdam optimizer since it is included in pytorch.
+* Do not include tests as installable package.
+* Preserver memory layout where possible.
+* Add MADGRAD optimizer.
+
+0.1.0 (2021-01-01)
 ------------------
 * Initial release.
+* Added support for A2GradExp, A2GradInc, A2GradUni, AccSGD, AdaBelief,
+  AdaBound, AdaMod, Adafactor, Adahessian, AdamP, AggMo, Apollo,
+  DiffGrad, Lamb, Lookahead, NovoGrad, PID, QHAdam, QHM, RAdam, Ranger,
+  RangerQH, RangerVA, SGDP, SGDW, SWATS, Shampoo, Yogi.

CITATION.cff

@@ -0,0 +1,9 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+  - family-names: Novik
+    given-names: Mykola
+    orcid: https://orcid.org/0000-0002-0890-1159
+title: "torch-optimizer -- collection of optimization algorithms for PyTorch."
+version: 1.0.1
+date-released: 2020-01-11

CONTRIBUTING.rst

@@ -0,0 +1,53 @@
+Contributing
+============
+
+Running Tests
+-------------
+
+.. _GitHub: https://github.com/jettify/pytorch-optimizer
+.. _PyTorch: https://github.com/pytorch/pytorch
+
+Thanks for your interest in contributing to ``pytorch-optimizer``, there are multiple
+ways and places you can contribute.
+
+First of all just clone repository::
+
+    $ git clone git@github.com:jettify/pytorch-optimizer.git
+
+Create virtualenv with python3.5 (older version are not supported). For example
+using *virtualenvwrapper* commands could look like::
+
+   $ cd pytorch-optimizer
+   $ mkvirtualenv --python=`which python3.7` pytorch-optimizer
+
+
+After that please install libraries required for development::
+
+    $ pip install -r requirements-dev.txt
+    $ pip install -e .
+
+Congratulations, you are ready to run the test suite::
+
+    $ make cov
+
+To run individual use following command::
+
+    $ py.test -sv tests/test_basic.py -k test_name
+
+
+Reporting an Issue
+------------------
+If you have found issue with `pytorch-optimizer` please do
+not hesitate to file an issue on the GitHub_ project. When filing your
+issue please make sure you can express the issue with a reproducible test
+case.
+
+When reporting an issue we also need as much information about your environment
+that you can include. We never know what information will be pertinent when
+trying narrow down the issue. Please include at least the following
+information:
+
+* Version of `pytorch-optimizer`, `python`.
+* Version PyTorch_ if installed.
+* Version or CUDA if installed.
+* Platform you're running on (OS X, Linux).

MANIFEST.in

@@ -2,7 +2,8 @@ include LICENSE
 include CHANGES.rst
 include README.rst
 include Makefile
-graft torch_inspect
+graft torch_optimizer
 graft tests
-global-exclude *.pyc
 prune docs/_build
+include examples/mnist.py
+global-exclude *.py[cod]

Makefile

@@ -1,8 +1,11 @@
 # Some simple testing tasks (sorry, UNIX only).
 
+FILES := torch_optimizer tests examples setup.py
+
+
 
 flake:
-	flake8 torch_optimizer tests examples setup.py
+	flake8  ${FILES}
 
 test: flake
 	pytest -sv
@@ -20,12 +23,22 @@ bandit:
 	bandit -r ./torch_optimizer
 
 mypy:
-	mypy torch_optimizer --ignore-missing-imports --strict
+	mypy torch_optimizer --ignore-missing-imports
 
-cov cover coverage: flake checkrst pyroma bandit
+checkbuild:
+	python setup.py sdist bdist_wheel
+	twine check dist/*
+
+cov cover coverage:
 	pytest -sv -vv --cov=torch_optimizer --cov-report=term --cov-report=html ./tests
 	@echo "open file://`pwd`/htmlcov/index.html"
 
+checkfmt:
+	isort --profile black  --check-only --diff $(FILES)
+	black -l 79 --check $(FILES)
+
+lint: flake checkrst pyroma bandit checkfmt
+
 clean:
 	rm -rf `find . -name __pycache__`
 	rm -f `find . -type f -name '*.py[co]' `
@@ -40,12 +53,18 @@ clean:
 	rm -rf build
 	rm -rf cover
 	rm -rf dist
+	rm -rf docs/_build
 
 doc:
 	make -C docs html
 	@echo "open file://`pwd`/docs/_build/html/index.html"
 
 black:
-	black -S -l 79 setup.py torch_optimizer/ tests/ examples/
+	black -l 79 setup.py torch_optimizer/ tests/ examples/
+
+fmt:
+	isort --profile black ${FILES}
+	black -l 79 ${FILES}
+
 
 .PHONY: all flake test vtest cov clean doc