[Update] Lots of stuff (#448)

* update: codes

* build(deps): dev deps

* docs: v3.8.2 changelog

* chore: disable warnings for pytest

* build(ci): split tasks

* fix: TypeAlias

* update: Parameters type

* build(deps): pytorch

* update: test_version_utils

* build(deps): pytorch

* update: test cases

* update: test cases

* update: test cases

* update: test cases

* update: test cases

* update: test cases

* build(ci): refactor publish script

* fix: test_version_utils

* build(ci): remove `check lint`

Author: kozistr

.github/workflows/ci.yml

@@ -9,13 +9,32 @@ on:
 env:
   OMP_NUM_THREADS: 2
   MKL_NUM_THREADS: 2
+  PYTHONDONTWRITEBYTECODE: 1
 
 jobs:
+  lint:
+    name: Lint / Static Checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          cache: 'pip'
+
+      - name: Install dev-dependencies
+        run: pip --disable-pip-version-check install --no-compile -r requirements-dev.txt
+
+      - name: Run lint
+        run: make check
+
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
     - uses: actions/checkout@v4
@@ -29,20 +48,25 @@ jobs:
     - name: Install dev-dependencies
       run: pip --disable-pip-version-check install --no-compile -r requirements-dev.txt
 
-    - name: Check lint
-      run: make check
-
     - name: Check test
-      env:
-        PYTHONDONTWRITEBYTECODE: 1
       run: make test
 
-    - name: Check codecov
+    - name: Upload coverage
+      if: success()
       uses: codecov/codecov-action@v5
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         directory: ./
         files: ./coverage.xml
         env_vars: OS,PYTHON
+        flags: ${{ matrix.python-version }}
         fail_ci_if_error: true
         verbose: false
+
+  ci-summary:
+    if: always()
+    needs: [lint, test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Report Summary
+        run: echo "✅ Lint and tests completed for all targets"

.github/workflows/publish.yml

@@ -6,9 +6,21 @@ on:
       - 'v*'
 
 jobs:
+
+  get-version:
+    name: Get Version
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.extract.outputs.version }}
+    steps:
+      - name: Extract tag version
+        id: extract
+        run: echo "version=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
+
   prepend-changelog:
     name: Prepend Change Log
     runs-on: ubuntu-latest
+    needs: get-version
 
     permissions:
       contents: write
@@ -18,38 +30,37 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Get the version
-        id: get_version
-        run: echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
-
       - name: Prepend changelog to CHANGELOG.md
         run: |
-          VERSION="${{ steps.get_version.outputs.VERSION }}"
+          VERSION="${{ needs.get-version.outputs.version }}"
           CHANGELOG_FILE="docs/changelogs/$VERSION.md"
-          MAIN_CHANGELOG="CHANGELOG.md"
 
           if [ ! -f "$CHANGELOG_FILE" ]; then
             echo "No changelog found for $VERSION"
             exit 1
           fi
 
+          MAIN_CHANGELOG="CHANGELOG.md"
           TMP_FILE=$(mktemp)
 
-          echo "# $VERSION" > "$TMP_FILE"
-          echo "" >> "$TMP_FILE"
-          cat "$CHANGELOG_FILE" >> "$TMP_FILE"
-          echo "" >> "$TMP_FILE"
-          cat "$MAIN_CHANGELOG" >> "$TMP_FILE"
+          {
+            echo "# $VERSION"
+            echo
+            cat "$CHANGELOG_FILE"
+            echo
+            cat "$MAIN_CHANGELOG"
+          } > "$TMP_FILE"
+
           mv "$TMP_FILE" "$MAIN_CHANGELOG"
 
       - name: Create Pull Request
         id: create_pull_request
         uses: peter-evans/create-pull-request@v6
         with:
-          branch: "docs/changelog-update-${{ steps.get_version.outputs.VERSION }}"
-          commit-message: "[skip ci] docs: prepend changelog for ${{ steps.get_version.outputs.VERSION }}"
-          title: "[Docs] Prepend changelog for ${{ steps.get_version.outputs.VERSION }}"
-          body: "Automated changelog update for ${{ steps.get_version.outputs.VERSION }}"
+          branch: "docs/changelog-update-${{ needs.get-version.outputs.version }}"
+          commit-message: "[skip ci] docs: prepend changelog for ${{ needs.get-version.outputs.version }}"
+          title: "[Docs] Prepend changelog for ${{ needs.get-version.outputs.version }}"
+          body: "Automated changelog update for ${{ needs.get-version.outputs.version }}"
           base: main
           delete-branch: true
           labels: automerge
@@ -58,14 +69,11 @@ jobs:
   release:
     name: Create Release
     runs-on: ubuntu-latest
+    needs: [get-version, prepend-changelog]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Get the version
-        id: get_version
-        run: echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
-
       - name: Create release
         id: create_release
         uses: actions/create-release@v1
@@ -74,14 +82,14 @@ jobs:
         with:
           tag_name: ${{ github.ref }}
           release_name: pytorch-optimizer ${{ github.ref }}
-          body_path: docs/changelogs/${{ steps.get_version.outputs.VERSION }}.md
+          body_path: docs/changelogs/${{ needs.get-version.outputs.version }}.md
           draft: false
           prerelease: false
 
   deploy:
     name: Deploy
-    needs: release
     runs-on: ubuntu-latest
+    needs: release
     steps:
       - uses: actions/checkout@v4
 

Makefile

@@ -10,7 +10,7 @@ check:
 	pyright pytorch_optimizer examples
 
 test:
-	python -m pytest -p no:pastebin -p no:nose -p no:doctest -sv -vv --cov=pytorch_optimizer --cov-report=xml ./tests
+	python -m pytest -p no:pastebin -p no:nose -p no:doctest --disable-warnings -sv -vv --cov=pytorch_optimizer --cov-report=xml ./tests
 
 requirements:
 	poetry export -f requirements.txt --output requirements.txt --without-hashes

docs/changelogs/v3.8.2.md

@@ -0,0 +1,9 @@
+## Change Log
+
+### Feature
+
+* Speed-up `zeropower_via_newtonschulz` up to 20% by utilizing `torch.baddmm` and `torch.addmm` ops. (#488)
+
+### Update
+
+* Refactor the type hints. (#448)