[pre-commit.ci] pre-commit suggestions (#20035)

pre-commit-ci[bot] · Borda · awaelchli · web-flow · commit a40affb953b2 · 2024-07-05T12:17:15.000-04:00
Co-authored-by: pre-commit-ci[bot] &lt;66853113+pre-commit-ci[bot]@users.noreply.github.com&gt;
Co-authored-by: Jirka Borovec &lt;6035284+Borda@users.noreply.github.com&gt;
Co-authored-by: awaelchli &lt;aedu.waelchli@gmail.com&gt;
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -6,7 +6,7 @@ In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
 size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
+level of experience, education, socioeconomic status, nationality, personal
 appearance, race, religion, or sexual identity and orientation.
 
 ## Our Standards
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -23,7 +23,7 @@ ci:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -51,7 +51,7 @@ repos:
       - id: detect-private-key
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
         additional_dependencies: [tomli]
@@ -70,7 +70,7 @@ repos:
       - id: sphinx-lint
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.5
+    rev: v0.5.0
     hooks:
       # try to fix what is possible
       - id: ruff
diff --git a/docs/source-pytorch/past_versions.rst b/docs/source-pytorch/past_versions.rst
@@ -3,7 +3,7 @@ Past PyTorch Lightning versions
 
 PyTorch Lightning :doc:`evolved over time <versioning>`. Here's the history of versions with links to their respective docs.
 
-To help you with keeping up to spead, check :doc:`Migration guide <upgrade/migration_guide>`.
+To help you with keeping up to speed, check :doc:`Migration guide <upgrade/migration_guide>`.
 
 .. list-table:: Past versions
    :widths: 5 50 30 15
diff --git a/examples/fabric/reinforcement_learning/train_fabric.py b/examples/fabric/reinforcement_learning/train_fabric.py
@@ -80,7 +80,7 @@ def main(args: argparse.Namespace):
     # Log hyperparameters
     fabric.logger.experiment.add_text(
         "hyperparameters",
-        "|param|value|\n|-|-|\n%s" % ("\n".join([f"|{key}|{value}|" for key, value in vars(args).items()])),
+        "|param|value|\n|-|-|\n{}".format("\n".join([f"|{key}|{value}|" for key, value in vars(args).items()])),
     )
 
     # Environment setup
diff --git a/examples/fabric/reinforcement_learning/train_fabric_decoupled.py b/examples/fabric/reinforcement_learning/train_fabric_decoupled.py
@@ -55,7 +55,7 @@ def player(args, world_collective: TorchCollective, player_trainer_collective: T
     # Log hyperparameters
     logger.experiment.add_text(
         "hyperparameters",
-        "|param|value|\n|-|-|\n%s" % ("\n".join([f"|{key}|{value}|" for key, value in vars(args).items()])),
+        "|param|value|\n|-|-|\n{}".format("\n".join([f"|{key}|{value}|" for key, value in vars(args).items()])),
     )
 
     # Environment setup
diff --git a/examples/fabric/reinforcement_learning/train_torch.py b/examples/fabric/reinforcement_learning/train_torch.py
@@ -138,7 +138,7 @@ def main(args: argparse.Namespace):
     if global_rank == 0:
         logger.add_text(
             "hyperparameters",
-            "|param|value|\n|-|-|\n%s" % ("\n".join([f"|{key}|{value}|" for key, value in vars(args).items()])),
+            "|param|value|\n|-|-|\n{}".format("\n".join([f"|{key}|{value}|" for key, value in vars(args).items()])),
         )
 
     # Environment setup
diff --git a/src/lightning/fabric/loggers/tensorboard.py b/src/lightning/fabric/loggers/tensorboard.py
@@ -107,7 +107,7 @@ def __init__(
         self._prefix = prefix
         self._fs = get_filesystem(root_dir)
 
-        self._experiment: Optional["SummaryWriter"] = None
+        self._experiment: Optional[SummaryWriter] = None
         self._kwargs = kwargs
 
     @property
diff --git a/src/lightning/fabric/strategies/deepspeed.py b/src/lightning/fabric/strategies/deepspeed.py
@@ -291,7 +291,7 @@ def __init__(
         self.hysteresis = hysteresis
         self.min_loss_scale = min_loss_scale
 
-        self._deepspeed_engine: Optional["DeepSpeedEngine"] = None
+        self._deepspeed_engine: Optional[DeepSpeedEngine] = None
 
     @property
     def zero_stage_3(self) -> bool:
diff --git a/src/lightning/fabric/strategies/model_parallel.py b/src/lightning/fabric/strategies/model_parallel.py
@@ -106,7 +106,7 @@ def __init__(
         self._timeout: Optional[timedelta] = timeout
         self._backward_sync_control = _ParallelBackwardSyncControl()
 
-        self._device_mesh: Optional["DeviceMesh"] = None
+        self._device_mesh: Optional[DeviceMesh] = None
 
     @property
     def device_mesh(self) -> "DeviceMesh":
diff --git a/src/lightning/pytorch/callbacks/progress/progress_bar.py b/src/lightning/pytorch/callbacks/progress/progress_bar.py
@@ -48,7 +48,7 @@ def on_train_batch_end(self, trainer, pl_module, outputs, batch, batch_idx):
     """
 
     def __init__(self) -> None:
-        self._trainer: Optional["pl.Trainer"] = None
+        self._trainer: Optional[pl.Trainer] = None
         self._current_eval_dataloader_idx: Optional[int] = None
 
     @property
diff --git a/src/lightning/pytorch/callbacks/progress/rich_progress.py b/src/lightning/pytorch/callbacks/progress/rich_progress.py
@@ -148,7 +148,7 @@ def __init__(
             self._trainer = trainer
             self._tasks: Dict[Union[int, TaskID], Any] = {}
             self._current_task_id = 0
-            self._metrics: Dict[Union[str, "Style"], Any] = {}
+            self._metrics: Dict[Union[str, Style], Any] = {}
             self._style = style
             self._text_delimiter = text_delimiter
             self._metrics_format = metrics_format
@@ -274,13 +274,13 @@ def __init__(
         self._console_kwargs = console_kwargs or {}
         self._enabled: bool = True
         self.progress: Optional[CustomProgress] = None
-        self.train_progress_bar_id: Optional["TaskID"]
-        self.val_sanity_progress_bar_id: Optional["TaskID"] = None
-        self.val_progress_bar_id: Optional["TaskID"]
-        self.test_progress_bar_id: Optional["TaskID"]
-        self.predict_progress_bar_id: Optional["TaskID"]
+        self.train_progress_bar_id: Optional[TaskID]
+        self.val_sanity_progress_bar_id: Optional[TaskID] = None
+        self.val_progress_bar_id: Optional[TaskID]
+        self.test_progress_bar_id: Optional[TaskID]
+        self.predict_progress_bar_id: Optional[TaskID]
         self._reset_progress_bar_ids()
-        self._metric_component: Optional["MetricsTextColumn"] = None
+        self._metric_component: Optional[MetricsTextColumn] = None
         self._progress_stopped: bool = False
         self.theme = theme
         self._update_for_light_colab_theme()
diff --git a/src/lightning/pytorch/callbacks/stochastic_weight_avg.py b/src/lightning/pytorch/callbacks/stochastic_weight_avg.py
@@ -123,7 +123,7 @@ def __init__(
         self._avg_fn = avg_fn or self.avg_fn
         self._device = device
         self._model_contains_batch_norm: Optional[bool] = None
-        self._average_model: Optional["pl.LightningModule"] = None
+        self._average_model: Optional[pl.LightningModule] = None
         self._initialized = False
         self._swa_scheduler: Optional[LRScheduler] = None
         self._scheduler_state: Optional[Dict] = None
diff --git a/src/lightning/pytorch/core/datamodule.py b/src/lightning/pytorch/core/datamodule.py
@@ -81,7 +81,7 @@ def teardown(self):
     def __init__(self) -> None:
         super().__init__()
         # Pointer to the trainer object
-        self.trainer: Optional["pl.Trainer"] = None
+        self.trainer: Optional[pl.Trainer] = None
 
     @classmethod
     def from_datasets(
diff --git a/src/lightning/pytorch/core/module.py b/src/lightning/pytorch/core/module.py
@@ -128,7 +128,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
 
         # pointer to the trainer object
-        self._trainer: Optional["pl.Trainer"] = None
+        self._trainer: Optional[pl.Trainer] = None
 
         # attributes that can be set by user
         self._example_input_array: Optional[Union[Tensor, Tuple, Dict]] = None
@@ -142,11 +142,11 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
         self._compiler_ctx: Optional[Dict[str, Any]] = None
 
         # attributes only used when using fabric
-        self._fabric: Optional["lf.Fabric"] = None
+        self._fabric: Optional[lf.Fabric] = None
         self._fabric_optimizers: List[_FabricOptimizer] = []
 
         # access to device mesh in `conigure_model()` hook
-        self._device_mesh: Optional["DeviceMesh"] = None
+        self._device_mesh: Optional[DeviceMesh] = None
 
     @overload
     def optimizers(
diff --git a/src/lightning/pytorch/plugins/precision/deepspeed.py b/src/lightning/pytorch/plugins/precision/deepspeed.py
@@ -113,7 +113,7 @@ def backward(  # type: ignore[override]
                 "You have overridden the `LightningModule.backward` hook but it will be ignored since DeepSpeed handles"
                 " the backward logic internally."
             )
-        deepspeed_engine: "deepspeed.DeepSpeedEngine" = model.trainer.model
+        deepspeed_engine: deepspeed.DeepSpeedEngine = model.trainer.model
         deepspeed_engine.backward(tensor, *args, **kwargs)
 
     @override
@@ -135,7 +135,7 @@ def optimizer_step(  # type: ignore[override]
                 "Skipping backward by returning `None` from your `training_step` is not supported by `DeepSpeed`"
             )
         # DeepSpeed handles the optimizer step internally
-        deepspeed_engine: "deepspeed.DeepSpeedEngine" = model.trainer.model
+        deepspeed_engine: deepspeed.DeepSpeedEngine = model.trainer.model
         return deepspeed_engine.step(**kwargs)
 
     @override
diff --git a/src/lightning/pytorch/profilers/pytorch.py b/src/lightning/pytorch/profilers/pytorch.py
@@ -301,8 +301,8 @@ def __init__(
         self._table_kwargs = table_kwargs if table_kwargs is not None else {}
 
         self.profiler: Optional[_PROFILER] = None
-        self.function_events: Optional["EventList"] = None
-        self._lightning_module: Optional["LightningModule"] = None  # set by ProfilerConnector
+        self.function_events: Optional[EventList] = None
+        self._lightning_module: Optional[LightningModule] = None  # set by ProfilerConnector
         self._register: Optional[RegisterRecordFunction] = None
         self._parent_profiler: Optional[ContextManager] = None
         self._recording_map: Dict[str, record_function] = {}
@@ -400,7 +400,7 @@ def _default_schedule() -> Optional[Callable]:
         return None
 
     def _default_activities(self) -> List["ProfilerActivity"]:
-        activities: List["ProfilerActivity"] = []
+        activities: List[ProfilerActivity] = []
         if not _KINETO_AVAILABLE:
             return activities
         if self._profiler_kwargs.get("use_cpu", True):
diff --git a/src/lightning/pytorch/strategies/model_parallel.py b/src/lightning/pytorch/strategies/model_parallel.py
@@ -93,7 +93,7 @@ def __init__(
         self._save_distributed_checkpoint = save_distributed_checkpoint
         self._process_group_backend: Optional[str] = process_group_backend
         self._timeout: Optional[timedelta] = timeout
-        self._device_mesh: Optional["DeviceMesh"] = None
+        self._device_mesh: Optional[DeviceMesh] = None
         self.num_nodes = 1
 
     @property
diff --git a/src/lightning/pytorch/strategies/strategy.py b/src/lightning/pytorch/strategies/strategy.py
@@ -52,7 +52,7 @@ def __init__(
         checkpoint_io: Optional[CheckpointIO] = None,
         precision_plugin: Optional[Precision] = None,
     ) -> None:
-        self._accelerator: Optional["pl.accelerators.Accelerator"] = accelerator
+        self._accelerator: Optional[pl.accelerators.Accelerator] = accelerator
         self._checkpoint_io: Optional[CheckpointIO] = checkpoint_io
         self._precision_plugin: Optional[Precision] = None
         # Call the precision setter for input validation
diff --git a/src/lightning/pytorch/utilities/_pytree.py b/src/lightning/pytorch/utilities/_pytree.py
@@ -25,7 +25,7 @@ def _tree_flatten(pytree: PyTree) -> Tuple[List[Any], TreeSpec]:
     child_pytrees, context = flatten_fn(pytree)
 
     result: List[Any] = []
-    children_specs: List["TreeSpec"] = []
+    children_specs: List[TreeSpec] = []
     for child in child_pytrees:
         flat, child_spec = _tree_flatten(child)
         result += flat
diff --git a/tests/tests_pytorch/helpers/utils.py b/tests/tests_pytorch/helpers/utils.py
@@ -31,7 +31,7 @@ def get_data_path(expt_logger, path_dir):
     name, version = expt_logger.name, expt_logger.version
 
     # the other experiments...
-    path_expt = os.path.join(path_dir, name, "version_%s" % version)
+    path_expt = os.path.join(path_dir, name, f"version_{version}")
 
     # try if the new sub-folder exists, typical case for test-tube
     if not os.path.isdir(path_expt):

Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ def main(args: argparse.Namespace):`
`80`	`80`	`# Log hyperparameters`
`81`	`81`	`fabric.logger.experiment.add_text(`
`82`	`82`	`"hyperparameters",`
`83`		`- "\|param\|value\|\n\|-\|-\|\n%s" % ("\n".join([f"\|{key}\|{value}\|" for key, value in vars(args).items()])),`
	`83`	`+ "\|param\|value\|\n\|-\|-\|\n{}".format("\n".join([f"\|{key}\|{value}\|" for key, value in vars(args).items()])),`
`84`	`84`	`)`
`85`	`85`
`86`	`86`	`# Environment setup`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ def player(args, world_collective: TorchCollective, player_trainer_collective: T`
`55`	`55`	`# Log hyperparameters`
`56`	`56`	`logger.experiment.add_text(`
`57`	`57`	`"hyperparameters",`
`58`		`- "\|param\|value\|\n\|-\|-\|\n%s" % ("\n".join([f"\|{key}\|{value}\|" for key, value in vars(args).items()])),`
	`58`	`+ "\|param\|value\|\n\|-\|-\|\n{}".format("\n".join([f"\|{key}\|{value}\|" for key, value in vars(args).items()])),`
`59`	`59`	`)`
`60`	`60`
`61`	`61`	`# Environment setup`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ def main(args: argparse.Namespace):`
`138`	`138`	`if global_rank == 0:`
`139`	`139`	`logger.add_text(`
`140`	`140`	`"hyperparameters",`
`141`		`- "\|param\|value\|\n\|-\|-\|\n%s" % ("\n".join([f"\|{key}\|{value}\|" for key, value in vars(args).items()])),`
	`141`	`+ "\|param\|value\|\n\|-\|-\|\n{}".format("\n".join([f"\|{key}\|{value}\|" for key, value in vars(args).items()])),`
`142`	`142`	`)`
`143`	`143`
`144`	`144`	`# Environment setup`