style: Bumps ruff to 0.1.11 (#229)

* chore: Bumps ruff to 0.1.11

* style: Updates precommits

* ci: Updates CI dep installation

* style: Updates precommit config

* docs: Updates copyright notice

* ci: Adds a job for precommit

.github/workflows/style.yml

@@ -21,7 +21,7 @@ jobs:
           architecture: x64
       - name: Run ruff
         run: |
-          pip install ruff==0.1.9
+          pip install ruff==0.1.11
           ruff --version
           ruff check --diff .
 
@@ -65,6 +65,25 @@ jobs:
           architecture: x64
       - name: Run ruff
         run: |
-          pip install ruff==0.1.9
+          pip install ruff==0.1.11
           ruff --version
           ruff format --check --diff .
+
+  precommit-hooks:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python: [3.9]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python }}
+          architecture: x64
+      - name: Run ruff
+        run: |
+          pip install pre-commit
+          pre-commit install
+          pre-commit --version
+          pre-commit run --all-files

.pre-commit-config.yaml

@@ -2,23 +2,27 @@ default_language_version:
     python: python3.9
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
-      - id: check-yaml
-        exclude: .conda
-      - id: check-toml
       - id: check-added-large-files
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
       - id: check-ast
+      - id: check-case-conflict
       - id: check-json
       - id: check-merge-conflict
-      - id: no-commit-to-branch
-        args: ['--branch', 'main']
+      - id: check-symlinks
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+        exclude: .conda
       - id: debug-statements
         language_version: python3
+      - id: end-of-file-fixer
+      - id: no-commit-to-branch
+        args: ['--branch', 'main']
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.1.9'
+    rev: 'v0.1.11'
     hooks:
       - id: ruff
         args:

demo/app.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2021-2023, François-Guillaume Fernandez.
+# Copyright (C) 2021-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

docs/source/conf.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

pyproject.toml

@@ -50,7 +50,7 @@ test = [
     "pytest-pretty>=1.0.0,<2.0.0",
 ]
 quality = [
-    "ruff==0.1.9",
+    "ruff==0.1.11",
     "mypy==1.8.0",
     "pre-commit>=3.0.0,<4.0.0",
 ]
@@ -78,7 +78,7 @@ dev = [
     "pytest-xdist>=3.0.0,<4.0.0",
     "pytest-pretty>=1.0.0,<2.0.0",
     # style
-    "ruff==0.1.9",
+    "ruff==0.1.11",
     "mypy==1.8.0",
     "pre-commit>=3.0.0,<4.0.0",
     # docs

scripts/cam_example.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

scripts/eval_latency.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2021-2023, François-Guillaume Fernandez.
+# Copyright (C) 2021-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

scripts/eval_perf.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

setup.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

torchcam/methods/_utils.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

torchcam/methods/activation.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

torchcam/methods/core.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

torchcam/methods/gradient.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.

torchcam/metrics.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2022-2023, François-Guillaume Fernandez.
+# Copyright (C) 2022-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.
@@ -57,6 +57,7 @@ def __init__(
         cam_extractor: _CAM,
         logits_fn: Union[Callable[[torch.Tensor], torch.Tensor], None] = None,
     ) -> None:
+        # This is a typa, I don't know how to rites
         self.cam_extractor = cam_extractor
         self.logits_fn = logits_fn
         self.reset()
@@ -65,6 +66,14 @@ def _get_probs(self, input_tensor: torch.Tensor) -> torch.Tensor:
         logits = self.cam_extractor.model(input_tensor)
         return cast(torch.Tensor, logits if self.logits_fn is None else self.logits_fn(logits))
 
+    def my_function(self) -> str:
+        """Returns a greeting message
+
+        Returns:
+            str: greeting message
+        """
+        return "Hello"
+
     def update(
         self,
         input_tensor: torch.Tensor,

torchcam/utils.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2020-2023, François-Guillaume Fernandez.
+# Copyright (C) 2020-2024, François-Guillaume Fernandez.
 
 # This program is licensed under the Apache License 2.0.
 # See LICENSE or go to <https://www.apache.org/licenses/LICENSE-2.0> for full license details.