Remove pydocstyle and configure ruff check for D rules

.pre-commit-config.yaml

@@ -32,17 +32,6 @@ repos:
 #           types: [python]
 #           require_serial: true
 #     rev: v2.12.2
-- repo: https://github.com/PyCQA/pydocstyle
-  hooks:
-  - id: pydocstyle
-    name: pydocstyle
-    entry: pydocstyle
-    language: python
-    types: [python]
-    exclude: "(?:tests|.ci|composer\/algorithms|composer\/datasets|composer\/models)\/.*|composer\/trainer\/activation_checkpointing.py"
-    additional_dependencies:
-    - "toml"
-  rev: 6.1.1
 - repo: https://github.com/adrienverge/yamllint.git
   rev: v1.28.0
   hooks:

composer/core/passes.py

@@ -33,7 +33,6 @@ def sort_to_front(list_to_sort: Sequence[T], cls: Any) -> Sequence[T]:
     """Helper function to sort instances of a provided class to the front.
 
     Example:
-
         .. testsetup::
 
             from composer.core.passes import sort_to_front
@@ -58,7 +57,6 @@ def sort_to_back(list_to_sort: Sequence[T], cls: Any) -> Sequence[T]:
     """Helper function to sort instances of a provided class to the back.
 
     Example:
-
         .. testsetup::
 
             from composer.core.passes import sort_to_back

composer/trainer/trainer.py

@@ -494,9 +494,8 @@ class Trainer:
     The :class:`.Trainer` is highly customizable and can support a wide variety of workloads.
     See the :doc:`training guide</trainer/using_the_trainer>` for more information.
 
-    Example
+    Example:
     --------
-
     Train a model and save a checkpoint:
 
     .. testcode::
@@ -747,8 +746,7 @@ class Trainer:
             Ignored if ``load_path`` is ``None``.
             (default: ``None``)
 
-            Example:
-
+    Example:
             .. testsetup::
 
                 import composer.trainer

composer/utils/dist.py

@@ -319,6 +319,7 @@ def all_reduce(
             enum.  Specifies an operation used for element-wise reductions.
         group (ProcessGroup, optional): The process group to work on. If ``None``,
             the default process group will be used. Default is ``None``.
+
     Args:
         tensor (torch.Tensor): Tensor to reduce. The function operates in-place.
         reduce_operation (str, optional): The reduction operation (default: ``SUM``).

composer/utils/eval_client/eval_client.py

@@ -35,6 +35,7 @@ def invoke(self, payload: list[list[list[dict[str, str]]]]) -> list[list[list[bo
 
         The JSON is formatted as [[[request]]] so that the client can batch requests. The outermost list is for the generations of a
         given prompt, the middle list is for the beam generations of a given prompt, and the innermost list is for each test cases.
+
         Args:
             payload: the materials of the batched HTTPS request to the client organized by prompt, beam generation, and test case.
 

composer/utils/import_helpers.py

@@ -45,8 +45,7 @@ def import_object(name: str) -> Any:
 
             Separate the module name and class name with a ``':'`` (e.g. ``'path.to.module:function_name'``).
 
-            Example:
-
+    Example:
                 >>> from composer.utils import import_object
                 >>> import_object('functools:partial')
                 <class 'functools.partial'>

composer/utils/module_surgery.py

@@ -14,7 +14,7 @@
         instances of the module type have been seen. The function should return a replacement
         :class:`torch.nn.Module` if the module type should be replaced, or ``None`` otherwise.
 
-        Args:
+Args:
             module (torch.nn.Module): Source module
             module_index (int): The i-th instance of module class.
 

pyproject.toml

@@ -15,8 +15,7 @@ split_on_trailing_comma = true
 [tool.ruff.lint]
 select = [
     "C4",
-    # TODO port pydocstyle
-    # "D", # pydocstyle
+    "D",
     "LOG",
     "PERF",
     "PLE",
@@ -27,7 +26,32 @@ ignore = [
     "C408",
     "PERF2",
     "PERF4",
+    "D102",
+    "D105",
+    "D107",
+    "D401",
+    "D203",
+    "D204",
+    "D213",
+    "D215",
+    "D401",
+    "D406",
+    "D407",
+    "D408",
+    "D409",
+    "D413",
+    "D417",
+    "D103"
 ]
+
+[tool.ruff.lint.per-file-ignores]
+".ci*" = ["D"]
+"tests/*" = ["D"]
+"composer/algorithms/*" = ["D"]
+"composer/datasets/*" = ["D"]
+"composer/models/*" = ["D"]
+"composer/trainer/activation_checkpointing.py" = ["D"]
+
 [tool.ruff]
 exclude = [
     "build/**",
@@ -1075,8 +1099,3 @@ min-public-methods=2
 # Exceptions that will emit a warning when being caught. Defaults to
 # "BaseException, Exception".
 overgeneral-exceptions="BaseException,Exception"
-
-[tool.pydocstyle]
-convention="google"
-add_ignore="D102,D105,D107,D401"
-add_select="D400,D404"