Exclude docs

Author: goanpeca

.github/pr-labeler-config.yml

@@ -1,55 +1,55 @@
 # Add 'docker' to any changes within 'docker' folder or any subfolders
 docker:
   - changed-files:
-    - any-glob-to-any-file: docker/**
+      - any-glob-to-any-file: docker/**
 
 # Add 'docs' to any changes within 'docs' folder
 docs:
   - changed-files:
-    - any-glob-to-any-file: docs/**
+      - any-glob-to-any-file: docs/**
 
 # Add 'ci' to any changes in '.github' folder
 ci:
   - changed-files:
-    - any-glob-to-any-file: .github/**
+      - any-glob-to-any-file: .github/**
 
 # Add 'examples' to any changes within 'examples' folder
 examples:
   - changed-files:
-    - any-glob-to-any-file: examples/**
+      - any-glob-to-any-file: examples/**
 
 # Add 'base' to any changes within 'base' folder
 "module: base":
   - changed-files:
-    - any-glob-to-any-file: ignite/base/**/*
+      - any-glob-to-any-file: ignite/base/**/*
 
 # Add 'contrib' to any changes within 'contrib' folder
 "module: contrib":
   - changed-files:
-    - any-glob-to-any-file: ignite/contrib/**/*
+      - any-glob-to-any-file: ignite/contrib/**/*
 
 # Add 'distributed' to any changes within 'distributed' folder
 "module: distributed":
   - changed-files:
-    - any-glob-to-any-file: ignite/distributed/**/*
+      - any-glob-to-any-file: ignite/distributed/**/*
 
 # Add 'engine' to any changes within 'engine' folder
 "module: engine":
   - changed-files:
-    - any-glob-to-any-file: ignite/engine/**/*
+      - any-glob-to-any-file: ignite/engine/**/*
 
 # Add 'handlers' to any changes within 'handlers' folder
 "module: handlers":
   - changed-files:
-    - any-glob-to-any-file: ignite/handlers/**/*
+      - any-glob-to-any-file: ignite/handlers/**/*
 
 # Add 'metrics' to any changes within 'metrics' folder
 "module: metrics":
   - changed-files:
-    - any-glob-to-any-file: ignite/metrics/**/*
+      - any-glob-to-any-file: ignite/metrics/**/*
 
   -
 # Add 'utils' to any changes within 'utils' module
 "module: utils":
   - changed-files:
-    - any-glob-to-any-file: ignite/utils.py
+      - any-glob-to-any-file: ignite/utils.py

.github/workflows/code-style.yml

@@ -13,7 +13,6 @@ on:
       - "!docs/**"
       - "!conda.recipe"
 
-
 jobs:
   code-style:
     runs-on: ubuntu-latest

.github/workflows/discord_issues.yml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
     inputs:
       issue_number:
-        description: 'Issue number'
+        description: "Issue number"
         required: true
 
 permissions:
@@ -26,5 +26,3 @@ jobs:
           issue_number: ${{ github.event.inputs.issue_number || github.event.issue.number }}
           issue_comment: Hey 👋, I've just created a [thread]($THREAD_LINK$) for this issue on [PyTorch-Ignite Discord](https://pytorch-ignite.ai/chat) where you can quickly talk to the community on the topic.
           discord_message: New issue created in `${{ github.repository }}`:<https://github.com/${{ github.repository }}/issues/${{ github.event.issue.number }}>
-
-

.github/workflows/discord_pull_requests.yaml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
     inputs:
       pull_request_number:
-        description: 'Pull request number'
+        description: "Pull request number"
         required: true
 
 permissions:

.github/workflows/docker-build.yml

@@ -9,14 +9,12 @@ on:
     types: [published]
   workflow_dispatch:
 
-
 concurrency:
   # <workflow_name>-<branch_name>-<true || commit_sha (if branch is protected)>
   group: docker-build-publish-${{ github.ref_name }}-${{ !(github.ref_protected) || github.sha }}
   cancel-in-progress: true
 
 jobs:
-
   setup:
     name: Setup
     runs-on: ubuntu-latest
@@ -46,7 +44,6 @@ jobs:
           echo "pth_version=$(python -c "import configparser; cfg=configparser.ConfigParser(); cfg.read('docker.cfg'); print(cfg.get('DEFAULT', 'build_docker_image_pytorch_version'))")" >> $GITHUB_OUTPUT
           echo "hvd_version=$(python -c "import configparser; cfg=configparser.ConfigParser(); cfg.read('docker.cfg'); print(cfg.get('DEFAULT', 'build_docker_image_hvd_version'))")" >> $GITHUB_OUTPUT
 
-
   build-hvd:
     name: Build all Horovod flavoured PyTorch-Ignite images
     needs: setup
@@ -106,7 +103,6 @@ jobs:
           bash push_all.sh hvd-vision
           bash push_all.sh hvd-nlp
 
-
   build-hvd-apex:
     name: Build all Horovod + Apex flavoured PyTorch-Ignite images
     needs: setup
@@ -166,7 +162,6 @@ jobs:
           bash push_all.sh hvd-apex-vision
           bash push_all.sh hvd-apex-nlp
 
-
   build-main:
     name: Build all PyTorch-Ignite images
     needs: setup
@@ -226,7 +221,6 @@ jobs:
           bash push_all.sh vision
           bash push_all.sh nlp
 
-
   build-main-apex:
     name: Build all PyTorch-Ignite images with Apex
     needs: setup

.github/workflows/pytorch-version-tests.yml

@@ -16,8 +16,7 @@ jobs:
       fail-fast: false
       matrix:
         python-version: [3.9, "3.10", "3.11"]
-        pytorch-version:
-          [2.5.1, 2.4.1, 2.3.1, 2.2.2, 1.13.1, 1.12.1, 1.10.0]
+        pytorch-version: [2.5.1, 2.4.1, 2.3.1, 2.2.2, 1.13.1, 1.12.1, 1.10.0]
         exclude:
           - pytorch-version: 1.10.0
             python-version: "3.10"

.github/workflows/triage.yml

@@ -19,7 +19,6 @@ jobs:
         with:
           configuration-path: .github/pr-labeler-config.yml
           repo-token: "${{ secrets.GITHUB_TOKEN }}"
-
 # Turned off due to unexpected behavior on issue opening+labeling? https://github.com/pytorch/ignite/issues/1836
 #       - name: Welcome
 #         uses: actions/first-interaction@v1

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-exclude: "^conda.recipe|assets"
+exclude: "^conda.recipe|assets|docs"
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
@@ -20,6 +20,7 @@ repos:
       # Run the linter
       - id: ruff-check
         types_or: [python, pyi]
+      # TODO: Enable when black and ruff format converge
       # Run the formatter
       # - id: ruff-format
       #   types_or: [python, pyi]

CONTRIBUTING.md

@@ -80,25 +80,28 @@ conda activate pytorch-ignite-dev
 
 ### Installation
 
-1) Make a fork of the repository on the GitHub (see [here](https://github.com/firstcontributions/first-contributions#fork-this-repository) for details).
-As a result, for example your username is `happy-ignite-developer`, then you should be able to see your fork on the GitHub, e.g https://github.com/happy-ignite-developer/ignite.git
+1. Make a fork of the repository on the GitHub (see [here](https://github.com/firstcontributions/first-contributions#fork-this-repository) for details).
+   As a result, for example your username is `happy-ignite-developer`, then you should be able to see your fork on the GitHub, e.g https://github.com/happy-ignite-developer/ignite.git
 
-2) Clone your fork locally and setup `upstream`. Assuming your username is `happy-ignite-developer`:
+2. Clone your fork locally and setup `upstream`. Assuming your username is `happy-ignite-developer`:
 
 ```bash
 git clone https://github.com/happy-ignite-developer/ignite.git
 cd ignite
 git remote add upstream https://github.com/pytorch/ignite.git
 git remote -v
 ```
+
 You might see the following output:
+
 ```
 origin  https://github.com/happy-ignite-developer/ignite.git (fetch)
 origin  https://github.com/happy-ignite-developer/ignite.git (push)
 upstream        https://github.com/pytorch/ignite (fetch)
 upstream        https://github.com/pytorch/ignite (push)
 ```
-3) Sync and install all necessary dependencies:
+
+3. Sync and install all necessary dependencies:
 
 ```bash
 git pull upstream master
@@ -287,9 +290,7 @@ for formatting docstrings, specially from an example of `Google style with Pytho
 - [`.. versionchanged::`] directive for adding new arguments, changing internal behaviours, fixing bugs and
 - [`.. deprecated::`] directive for deprecations.
 
-Examples: ``versionadded`` usage [link](https://github.com/pytorch/ignite/blob/52c69251dd9d97c32da1df0477ec3854e5702029/ignite/handlers/state_param_scheduler.py#L24), ``versionchanged`` usage [link](https://github.com/pytorch/ignite/blob/d2020e4e253ac1455a757c2db895c68ccfd2b958/ignite/metrics/metric.py#L281-L282)
-
-
+Examples: `versionadded` usage [link](https://github.com/pytorch/ignite/blob/52c69251dd9d97c32da1df0477ec3854e5702029/ignite/handlers/state_param_scheduler.py#L24), `versionchanged` usage [link](https://github.com/pytorch/ignite/blob/d2020e4e253ac1455a757c2db895c68ccfd2b958/ignite/metrics/metric.py#L281-L282)
 
 Length of line inside docstrings block must be limited to 120 characters.
 

docker/README.md

@@ -50,6 +50,7 @@ Available Tensor Operations:
   - `docker pull pytorchignite/hvd-apex-nlp:latest`
 
 **Deprecated images** (no version updates)
+
 - [msdp/Dockerfile.msdp-apex-base](msdp/Dockerfile.msdp-apex): multi-stage MSDeepSpeed build with latest Pytorch, Ignite image with minimal dependencies
   - `docker pull pytorchignite/msdp-apex:latest`
 - [msdp/Dockerfile.msdp-apex-vision](msdp/Dockerfile.msdp-apex-vision): base MSDeepSpeed build with useful computer vision libraries