pytorch_optimizer 3.9.0__tar.gz → 3.10.1__tar.gz

pytorch_optimizer-3.10.1/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

pytorch_optimizer-3.10.1/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @kozistr

pytorch_optimizer-3.10.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: kozistr
+
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## To Reproduce
+
+* OS : (e.g. Linux, Windows, MacOS)
+* PyTorch version : (e.g. 2.0.1, 1.13, >=1.8, <1.10)
+* Python version :  (e.g. 3.8, 3.11)
+* pytorch-optimizer version : (e.g. 3.3.0)
+* reproducible codes : please share your reproducible codes, scripts, or links. If sharing the code is complicated, you can manually write minimal code to reproduce bugs!
+
+Here's an [example](https://github.com/kozistr/pytorch_optimizer/issues/305#issue-2721453417).
+
+## Log
+
+attach the complete log here! (highlighted texts or screenshots are welcome)
+
+## Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+## Additional context
+
+Add any other context about the problem here.

pytorch_optimizer-3.10.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,12 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: kozistr
+
+---
+
+## Paper or Code
+
+here!

pytorch_optimizer-3.10.1/.github/labeler.yml

@@ -0,0 +1,32 @@
+documentation:
+  - changed-files:
+    - any-glob-to-any-file:
+      - '**/*.md'
+
+github_actions:
+  - changed-files:
+    - any-glob-to-any-file:
+      - .github/workflows/**
+
+dependencies:
+  - changed-files:
+    - any-glob-to-any-file:
+      - pyproject.toml
+      - requirements.txt
+      - requirements-dev.txt
+      - requirements-docs.txt
+
+optimizer:
+  - changed-files:
+      - any-glob-to-any-file:
+          - pytorch_optimizer/optimizer/**
+
+loss:
+  - changed-files:
+      - any-glob-to-any-file:
+          - pytorch_optimizer/loss/**
+
+lr_scheduler:
+  - changed-files:
+      - any-glob-to-any-file:
+          - pytorch_optimizer/lr_scheduler/**

pytorch_optimizer-3.10.1/.github/labels.yml

@@ -0,0 +1,24 @@
+XS:
+  name: size/XS
+  lines: 0
+  color: 3CBF00
+S:
+  name: size/S
+  lines: 20
+  color: 5D9801
+M:
+  name: size/M
+  lines: 100
+  color: 7F7203
+L:
+  name: size/L
+  lines: 250
+  color: A14C05
+XL:
+  name: size/XL
+  lines: 500
+  color: C32607
+XXL:
+  name: size/XXL
+  lines: 1000
+  color: E50009

pytorch_optimizer-3.10.1/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+## Problem (Why?)
+
+_What problem are you trying to solve?_
+
+## Solution (What/How?)
+
+_How did you solve the problem? Please provide a complete description and explanation!_
+
+## Other changes (bug fixes, small refactors)
+
+_Are there any small changes?_
+
+## Notes
+
+_Please note any questions, helps or contexts what maintainer(s) should know_
+
+## Checklist
+
+- [ ] Make sure to run `make format` before commit
+- [ ] My code adheres to the style guidelines of this project (`make check` shows no errors)
+- [ ] Both new and existing unit tests pass successfully on my local environment by running `make test`
+- [ ] I have made the necessary changes to the documentation

pytorch_optimizer-3.10.1/.github/workflows/ci.yml

@@ -0,0 +1,100 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  OMP_NUM_THREADS: 8
+  MKL_NUM_THREADS: 8
+  PYTHONDONTWRITEBYTECODE: 1
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: 3.12
+          enable-cache: true
+          prune-cache: false
+
+      - name: Install dependencies
+        run: uv sync --frozen --no-editable
+
+      - name: Run lint
+        run: |
+          uv run ruff check pytorch_optimizer examples tests scripts hubconf.py
+          uv run black -S -l 119 --check pytorch_optimizer examples tests scripts hubconf.py
+
+  type_check:
+    name: Static Type Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: 3.12
+          enable-cache: true
+          prune-cache: false
+
+      - name: Install dependencies
+        run: uv sync --frozen --no-editable
+
+      - uses: jakebailey/pyright-action@v2
+        with:
+          version: 1.1.408
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
+
+    steps:
+    - uses: actions/checkout@v5
+
+    - name: Setup uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        python-version: ${{ matrix.python-version }}
+        enable-cache: true
+        prune-cache: false
+
+    - name: Install dependencies
+      run: uv sync --frozen --no-editable
+
+    - name: Check test
+      run: uv run --frozen pytest
+
+    - 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, type_check, test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check results
+        if: needs.lint.result == 'failure' || needs.type_check.result == 'failure' || needs.test.result == 'failure'
+        run: exit 1
+
+      - name: Report Summary
+        run: echo "✅ Lint and tests completed for all targets"

pytorch_optimizer-3.10.1/.github/workflows/copy_readme.yml

@@ -0,0 +1,25 @@
+name: Copy README.md to docs/index.md
+
+on:
+  pull_request:
+    paths:
+      - README.md
+
+jobs:
+  copy-readme:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Copy README.md to docs/index.md
+        run: cp README.md docs/index.md
+
+      - name: Commit updated index.md
+        uses: stefanzweifel/git-auto-commit-action@v6
+        id: auto-commit-action
+        with:
+          commit_message: "docs: update index.md"
+          file_pattern: docs/index.md
+          commit_user_name: "pytorch_optimizer-actions[bot]"
+          commit_user_email: "pytorch_optimizer-actions[bot]@users.noreply.github.com"
+          push_options: "--force"

pytorch_optimizer-3.10.1/.github/workflows/pr_automerge.yml

@@ -0,0 +1,36 @@
+name: "Automerge PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+  check_suite:
+    types:
+      - completed
+
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+      - id: automerge
+        if: ${{ contains(github.event.pull_request.labels.*.name, 'automerge') }}
+        name: automerge
+        uses: pascalgn/automerge-action@v0.16.4
+        env:
+          MERGE_LABELS: "automerge"
+          MERGE_METHOD_LABEL_REQUIRED: "false"
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+          MERGE_METHOD: "squash"
+          MERGE_REQUIRED_APPROVALS: "0"
+          MERGE_DELETE_BRANCH: "true"
+          MERGE_ERROR_FAIL: "true"
+
+      - name: feedback
+        if: ${{ steps.automerge.outputs.mergeResult == 'merged' }}
+        run: echo "Pull request ${{ steps.automerge.outputs.pullRequestNumber }} merged!"

pytorch_optimizer-3.10.1/.github/workflows/pr_codeql.yml

@@ -0,0 +1,48 @@
+name: "CodeQL"
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - ready_for_review
+    branches:
+      - main
+    paths:
+      - pytorch_optimizer/**
+  schedule:
+    - cron: '0 9 * * 0'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  analyze:
+    if: github.event.pull_request.draft == false
+    name: Analyze
+    runs-on: 'ubuntu-latest'
+    timeout-minutes: 30
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4
+      with:
+        category: "/language:${{matrix.language}}"

pytorch_optimizer-3.10.1/.github/workflows/pr_labeler.yml

@@ -0,0 +1,25 @@
+name: Label PR
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - labeled
+      - unlabeled
+
+jobs:
+  labeler:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/labeler@v5
+        if: ${{ github.event.action != 'labeled' && github.event.action != 'unlabeled' && !contains(github.event.pull_request.labels.*.name, 'automerge') }}
+        with:
+          configuration-path: '.github/labeler.yml'

pytorch_optimizer-3.10.1/.github/workflows/publish.yml

@@ -0,0 +1,110 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - '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
+      pull-requests: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Prepend changelog to CHANGELOG.md
+        run: |
+          VERSION="${{ needs.get-version.outputs.version }}"
+          CHANGELOG_FILE="docs/changelogs/$VERSION.md"
+
+          if [ ! -f "$CHANGELOG_FILE" ]; then
+            echo "No changelog found for $VERSION"
+            exit 1
+          fi
+
+          MAIN_CHANGELOG="CHANGELOG.md"
+          TMP_FILE=$(mktemp)
+
+          {
+            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-${{ 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
+          token: ${{ secrets.GH_TOKEN }}
+
+  release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    needs: [get-version, prepend-changelog]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Create release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: docs/changelogs/${{ needs.get-version.outputs.version }}.md
+          draft: false
+          prerelease: false
+          name: pytorch-optimizer ${{ needs.get-version.outputs.version }}
+          tag_name: ${{ github.ref }}
+          token: ${{ secrets.GH_TOKEN }}
+
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          python-version: 3.12
+          enable-cache: true
+          prune-cache: false
+
+      - name: Install dependencies
+        run: uv sync --frozen --no-dev
+
+      - name: Publish package to PyPI
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          uv build
+          uv publish

pytorch_optimizer-3.10.1/.github/workflows/update_docs.yml

@@ -0,0 +1,33 @@
+name: Update Documentation
+
+on:
+  pull_request:
+    paths:
+      - 'pytorch_optimizer/__init__.py'
+      - 'pytorch_optimizer/optimizer/__init__.py'
+      - 'pytorch_optimizer/lr_scheduler/__init__.py'
+      - 'pytorch_optimizer/loss/__init__.py'
+
+jobs:
+  update-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Update documentation files
+        run: python scripts/update_docs.py
+
+      - name: Commit updated documentation
+        uses: stefanzweifel/git-auto-commit-action@v6
+        id: auto-commit-action
+        with:
+          commit_message: "docs: update documentation"
+          file_pattern: "docs/optimizer.md docs/lr_scheduler.md docs/loss.md"
+          commit_user_name: "pytorch_optimizer-actions[bot]"
+          commit_user_email: "pytorch_optimizer-actions[bot]@users.noreply.github.com"
+          push_options: "--force"

pytorch_optimizer-3.10.1/.gitignore

@@ -0,0 +1,33 @@
+*~
+\#*\#
+.\#*
+.idea/
+.DS_Store
+._*
+__pycache__/
+*.py[cod]
+*$py.class
+build/
+*.egg-info/
+target/
+htmlcov/
+.coverage
+.coverage.*
+.cache
+coverage.xml
+*.cover
+.pytest_cache/
+.mypy_cache/
+.env
+venv/
+env/
+_build/
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+.netrwhist
+.vscode/*
+.history
+site/