torchebm 0.2.4__tar.gz

torchebm-0.2.4/.github/workflows/docs_ci.yml

@@ -0,0 +1,129 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: |
+          python -m pip install -e .[docs]
+          pip install -e .
+      - name: Generate API Documentation
+        run: |
+          python generate_api_docs.py
+      - name: Extract Version
+        run: |
+          # Get version from SCM (setuptools_scm)
+          python -c "from torchebm._version import version; print(f'VERSION={version}')" >> $GITHUB_ENV
+      - name: Setup gh-pages branch
+        run: |
+          # Initialize gh-pages branch if it doesn't exist
+          git fetch origin gh-pages || git checkout --orphan gh-pages
+          if ! git show-ref --verify --quiet refs/remotes/origin/gh-pages; then
+            # If gh-pages doesn't exist on remote, create it
+            git checkout --orphan gh-pages
+            git rm -rf .
+            touch .nojekyll
+            git add .nojekyll
+            git commit -m "Initialize gh-pages branch"
+            git push -u origin gh-pages
+            git checkout -
+          else
+            # If it exists, ensure we have it locally
+            git checkout gh-pages || git checkout -b gh-pages origin/gh-pages
+            # Make sure it's up to date
+            git pull origin gh-pages
+            git checkout -
+          fi
+      - name: Extract clean version
+        run: |
+          # Extract clean version without build metadata for mike
+          CLEAN_VERSION=$(echo $VERSION | cut -d'+' -f1)
+          echo "CLEAN_VERSION=${CLEAN_VERSION}" >> $GITHUB_ENV
+      - name: Build Documentation
+        run: |
+          # Print MkDocs configuration
+          echo "MkDocs configuration:"
+          cat mkdocs.yml | grep -E "site_dir|docs_dir" || echo "No site_dir or docs_dir specified in mkdocs.yml"
+          
+          # First build the documentation to generate the site directory
+          mkdocs build -v
+          
+          # Check the output directory after build
+          echo "Directories after build:"
+          ls -la
+          
+          # Create .nojekyll file in the root to prevent GitHub Pages from using Jekyll
+          touch .nojekyll
+          
+          # Make sure the site directory exists before creating .nojekyll inside it
+          if [ -d "site" ]; then
+            touch site/.nojekyll
+            echo "Site directory found, created .nojekyll inside it"
+          else
+            echo "Warning: Site directory not found. Checking alternative directories..."
+            for dir in public/ _site/ build/ docs/site/ site_docs/; do
+              if [ -d "$dir" ]; then
+                echo "Found alternative directory: $dir"
+                touch "$dir/.nojekyll"
+                # Create symlink to make things consistent
+                ln -sf "$dir" site
+                break
+              fi
+            done
+          fi
+      - name: Deploy with Mike
+        run: |
+          # Check that we have a valid version to deploy
+          if [ -z "${CLEAN_VERSION}" ]; then
+            echo "Error: No version found to deploy"
+            exit 1
+          fi
+
+          echo "Deploying version: ${CLEAN_VERSION}"
+          
+          # List current mike versions
+          mike list || echo "No versions found yet"
+          
+          # Print mike configuration
+          echo "Mike configuration:"
+          mike --help
+          
+          # Verify site directory exists before deploying
+          if [ ! -d "site" ]; then
+            echo "Error: 'site' directory not found. Cannot deploy with mike."
+            exit 1
+          fi
+          
+          # Deploy with Mike - first remove latest alias if it exists
+          mike delete --push latest || true
+          
+          # Deploy the new version and set it as latest
+          mike deploy --push --update-aliases ${CLEAN_VERSION} latest
+          
+          # Set default version to latest
+          mike set-default --push latest
+          
+          echo "Deployment completed successfully!"

torchebm-0.2.4/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags like v1.0.0
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run tests
+        run: |
+          pytest tests/  # Adjust the path to your test directory
+
+      - name: Build the package
+        run: |
+          python -m pip install --upgrade build
+          python -m build  # This will create .tar.gz and .whl files in the dist/ directory
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          username: __token__
+          password: ${{ secrets.PYPI_API_TOKEN_EBM }}

torchebm-0.2.4/.github/workflows/tag-release.yml

@@ -0,0 +1,206 @@
+#name: Release and Publish
+#
+#on:
+#  push:
+#    branches:
+#      - master  # Adjust as necessary
+#
+#jobs:
+#  release:
+#    runs-on: ubuntu-latest
+#
+#    steps:
+#      - name: Checkout code
+#        uses: actions/checkout@v3
+#
+#      - name: Get latest tag
+#        id: get_latest_tag
+#        run: |
+#          git fetch --tags
+#          TAG=$(git tag --sort=-creatordate | head -n 1)
+#          echo "Latest tag is $TAG"
+#          echo "::set-output name=latest::$TAG"
+#
+#      - name: Determine new version
+#        id: new_version
+#        run: |
+#          latest_tag="${{ steps.get_latest_tag.outputs.latest }}"
+#          if [ -z "$latest_tag" ]; then
+#            new_version="0.1.0"  # No 'v' prefix for version number
+#          else
+#            # Increment the patch version
+#            new_version=$(echo $latest_tag | awk -F. -v OFS=. '{$NF++;print}' | sed 's/^v//')
+#          fi
+#          echo "New version is $new_version"
+#          echo "::set-output name=new_version::$new_version"
+#
+#      - name: Update pyproject.toml version
+#        run: |
+#          sed -i "s/^version = .*/version = \"${{ steps.new_version.outputs.new_version }}\"/" pyproject.toml
+#
+#      - name: Create new tag
+#        run: |
+#          git tag "v${{ steps.new_version.outputs.new_version }}"
+#          git push origin "v${{ steps.new_version.outputs.new_version }}"
+#
+#      - name: Set up Python
+#        uses: actions/setup-python@v4
+#        with:
+#          python-version: '3.10'
+#
+#      - name: Install dependencies
+#        run: |
+#          python -m pip install --upgrade pip
+#          pip install -r requirements.txt
+#
+#      - name: Set PYTHONPATH
+#        run: echo "PYTHONPATH=$(pwd)/torchebm" >> $GITHUB_ENV
+#
+#      - name: Install package
+#        run: |
+#          pip install .
+#
+#      - name: Run tests
+#        run: |
+#          pytest tests/  # Adjust the path to your test directory
+#
+#      - name: Build the package
+#        run: |
+#          python -m pip install --upgrade build
+#          python -m build  # This will create .tar.gz and .whl files in the dist/ directory
+#
+#      - name: Publish to PyPI
+#        uses: pypa/gh-action-pypi-publish@release/v1
+#        with:
+#          username: __token__  # Use __token__ for token-based authentication
+#          password: ${{ secrets.PYPI_API_TOKEN_EBM }}
+
+
+name: Automated Tagging and Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update-tag:
+    runs-on: ubuntu-latest
+    outputs:
+      new_tag: ${{ steps.create_tag.outputs.new_tag }}
+      update_type: ${{ steps.get_update_type.outputs.update_type }}
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Get update type from commit message
+      id: get_update_type
+      run: |
+        commit_message="${{ github.event.head_commit.message }}"
+        if [[ "$commit_message" == *"#major"* ]]; then
+          echo "update_type=major" >> $GITHUB_OUTPUT
+        elif [[ "$commit_message" == *"#minor"* ]]; then
+          echo "update_type=minor" >> $GITHUB_OUTPUT
+        else
+          echo "update_type=patch" >> $GITHUB_OUTPUT
+        fi
+
+    - name: Get latest tag
+      id: get_latest_tag
+      run: |
+        git fetch --tags
+        latest_tag=$(git describe --tags `git rev-list --tags --max-count=1` 2>/dev/null || echo "")
+        echo "latest_tag=${latest_tag}" >> $GITHUB_OUTPUT
+
+    - name: Create new tag
+      id: create_tag
+      run: |
+        latest_tag=${{ steps.get_latest_tag.outputs.latest_tag }}
+        update_type=${{ steps.get_update_type.outputs.update_type }}
+        
+        if [ -z "$latest_tag" ]; then
+          new_tag="v0.1.0"
+        else
+          IFS='.' read -ra VERSION <<< "${latest_tag#v}"
+          major=${VERSION[0]}
+          minor=${VERSION[1]}
+          patch=${VERSION[2]}
+          
+          case $update_type in
+            major)
+              major=$((major+1))
+              minor=0
+              patch=0
+              ;;
+            minor)
+              minor=$((minor+1))
+              patch=0
+              ;;
+            patch)
+              patch=$((patch+1))
+              ;;
+          esac
+          
+          new_tag="v$major.$minor.$patch"
+        fi
+        
+        echo "new_tag=${new_tag}" >> $GITHUB_OUTPUT
+        git config user.name github-actions
+        git config user.email github-actions@github.com
+        git tag $new_tag
+        git push origin $new_tag
+
+  release:
+    needs: update-tag
+    if: contains(github.event.head_commit.message, '#release')
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+        cache: 'pip'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+        pip install build twine wheel
+
+    - name: Install package for testing
+      run: pip install -e .
+
+    - name: Run tests
+      run: pytest tests/
+
+    - name: Build package
+      run: |
+        python -m build --sdist --wheel
+        python -m twine check dist/*
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        username: __token__
+        password: ${{ secrets.PYPI_API_TOKEN_EBM }}
+        verbose: true
+
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v1
+      with:
+        tag_name: ${{ needs.update-tag.outputs.new_tag }}
+        name: Release ${{ needs.update-tag.outputs.new_tag }}
+        draft: false
+        prerelease: false
+        generate_release_notes: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

torchebm-0.2.4/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+dist
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+/scope.txt
+/.venv13/

torchebm-0.2.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TorchEBM Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.