start

Author: srush

files_to_sync.txt

@@ -4,11 +4,11 @@
 
 
 class Module:
-    """
-    Modules form a tree that store parameters and other
+    """Modules form a tree that store parameters and other
     submodules. They make up the basis of neural network stacks.
 
-    Attributes:
+    Attributes
+    ----------
         _modules : Storage of the child modules
         _parameters : Storage of the module's parameters
         training : Whether the module is in training mode or evaluation mode
@@ -25,46 +25,48 @@ def __init__(self) -> None:
         self.training = True
 
     def modules(self) -> Sequence[Module]:
-        "Return the direct child modules of this module."
+        """Return the direct child modules of this module."""
         m: Dict[str, Module] = self.__dict__["_modules"]
         return list(m.values())
 
     def train(self) -> None:
-        "Set the mode of this module and all descendent modules to `train`."
+        """Set the mode of this module and all descendent modules to `train`."""
         # TODO: Implement for Task 0.4.
         raise NotImplementedError("Need to implement for Task 0.4")
 
     def eval(self) -> None:
-        "Set the mode of this module and all descendent modules to `eval`."
+        """Set the mode of this module and all descendent modules to `eval`."""
         # TODO: Implement for Task 0.4.
         raise NotImplementedError("Need to implement for Task 0.4")
 
     def named_parameters(self) -> Sequence[Tuple[str, Parameter]]:
-        """
-        Collect all the parameters of this module and its descendents.
+        """Collect all the parameters of this module and its descendents.
 
-
-        Returns:
+        Returns
+        -------
             The name and `Parameter` of each ancestor parameter.
+
         """
         # TODO: Implement for Task 0.4.
         raise NotImplementedError("Need to implement for Task 0.4")
 
     def parameters(self) -> Sequence[Parameter]:
-        "Enumerate over all the parameters of this module and its descendents."
+        """Enumerate over all the parameters of this module and its descendents."""
         # TODO: Implement for Task 0.4.
         raise NotImplementedError("Need to implement for Task 0.4")
 
     def add_parameter(self, k: str, v: Any) -> Parameter:
-        """
-        Manually add a parameter. Useful helper for scalar parameters.
+        """Manually add a parameter. Useful helper for scalar parameters.
 
         Args:
+        ----
             k: Local name of the parameter.
             v: Value for the parameter.
 
         Returns:
+        -------
             Newly created parameter.
+
         """
         val = Parameter(v, k)
         self.__dict__["_parameters"][k] = val
@@ -118,8 +120,7 @@ def _addindent(s_: str, numSpaces: int) -> str:
 
 
 class Parameter:
-    """
-    A Parameter is a special container stored in a `Module`.
+    """A Parameter is a special container stored in a `Module`.
 
     It is designed to hold a `Variable`, but we allow it to hold
     any value for testing.
@@ -134,7 +135,7 @@ def __init__(self, x: Any, name: Optional[str] = None) -> None:
                 self.value.name = self.name
 
     def update(self, x: Any) -> None:
-        "Update the parameter value."
+        """Update the parameter value."""
         self.value = x
         if hasattr(x, "requires_grad_"):
             self.value.requires_grad_(True)

minitorch/module.py

@@ -1,6 +1,4 @@
-"""
-Collection of the core mathematical operators used throughout the code base.
-"""
+"""Collection of the core mathematical operators used throughout the code base."""
 
 import math
 

minitorch/operators.py

@@ -7,8 +7,16 @@ name = "minitorch"
 version = "0.5"
 
 [tool.pyright]
-include = ["minitorch","tests"] 
-exclude = ["**/docs", "**/project", "**/mt_diagrams", "**/assignments"]
+include = ["**/minitorch"]
+exclude = [
+    "**/docs",
+    "**/docs/module1/**",
+    "**/assignments",
+    "**/project",
+    "**/mt_diagrams",
+    "**/.*",
+    "*chainrule.py*",
+]
 venvPath = "."
 venv = ".venv"
 reportUnknownMemberType = "none"
@@ -21,6 +29,8 @@ reportUnusedExpression = "none"
 reportUnknownLambdaType = "none"
 reportIncompatibleMethodOverride = "none"
 reportPrivateUsage = "none"
+reportMissingParameterType = "error"
+
 
 [tool.pytest.ini_options]
 markers = [
@@ -50,7 +60,91 @@ markers = [
     "task4_3",
     "task4_4",
 ]
+[tool.ruff]
+
+exclude = [
+    ".git",
+    "__pycache__",
+    "**/docs/slides/*",
+    "old,build",
+    "dist",
+    "**/project/**/*",
+    "**/mt_diagrams/*",
+    "**/minitorch/testing.py",
+    "**/docs/**/*",
+]
+
+ignore = [
+    "ANN101",
+    "ANN401",
+    "N801",
+    "E203",
+    "E266",
+    "E501",
+    "E741",
+    "N803",
+    "N802",
+    "N806",
+    "D400",
+    "D401",
+    "D105",
+    "D415",
+    "D205",
+    "D100",
+    "D101",
+    "D107",
+    "D213",
+    "ANN204",
+    "ANN102",
+]
+select = ["D", "E", "F", "N", "ANN"]
+fixable = [
+    "A",
+    "B",
+    "C",
+    "D",
+    "E",
+    "F",
+    "G",
+    "I",
+    "N",
+    "Q",
+    "S",
+    "T",
+    "W",
+    "ANN",
+    "ARG",
+    "BLE",
+    "COM",
+    "DJ",
+    "DTZ",
+    "EM",
+    "ERA",
+    "EXE",
+    "FBT",
+    "ICN",
+    "INP",
+    "ISC",
+    "NPY",
+    "PD",
+    "PGH",
+    "PIE",
+    "PL",
+    "PT",
+    "PTH",
+    "PYI",
+    "RET",
+    "RSE",
+    "RUF",
+    "SIM",
+    "SLF",
+    "TCH",
+    "TID",
+    "TRY",
+    "UP",
+    "YTT",
+]
+unfixable = []
 
-[tool.ruff.lint]
-ignore = ["N801", "E203", "E266", "E501", "E741", "N803", "N802", "N806"]
-exclude = [".git","__pycache__","docs/slides/*","old,build","dist"]
+[tool.ruff.extend-per-file-ignores]
+"tests/**/*.py" = ["D"]

pyproject.toml

@@ -44,7 +44,7 @@ def __init__(self) -> None:
 
 @pytest.mark.task0_4
 def test_stacked_demo() -> None:
-    "Check that each of the properties match"
+    """Check that each of the properties match"""
     mod = ModuleA1()
     np = dict(mod.named_parameters())
 
@@ -95,7 +95,7 @@ def __init__(self) -> None:
 @pytest.mark.task0_4
 @given(med_ints, med_ints)
 def test_module(size_a: int, size_b: int) -> None:
-    "Check the properties of a single module"
+    """Check the properties of a single module"""
     module = Module2()
     module.eval()
     assert not module.training
@@ -116,7 +116,7 @@ def test_module(size_a: int, size_b: int) -> None:
 @pytest.mark.task0_4
 @given(med_ints, med_ints, small_floats)
 def test_stacked_module(size_a: int, size_b: int, val: float) -> None:
-    "Check the properties of a stacked module"
+    """Check the properties of a stacked module"""
     module = Module1(size_a, size_b, val)
     module.eval()
     assert not module.training

tests/test_module.py

@@ -5,6 +5,7 @@
 from hypothesis.strategies import lists
 
 from minitorch import MathTest
+import minitorch
 from minitorch.operators import (
     add,
     addLists,
@@ -32,7 +33,7 @@
 @pytest.mark.task0_1
 @given(small_floats, small_floats)
 def test_same_as_python(x: float, y: float) -> None:
-    "Check that the main operators all return the same value of the python version"
+    """Check that the main operators all return the same value of the python version"""
     assert_close(mul(x, y), x * y)
     assert_close(add(x, y), x + y)
     assert_close(neg(x), -x)
@@ -68,7 +69,7 @@ def test_id(a: float) -> None:
 @pytest.mark.task0_1
 @given(small_floats)
 def test_lt(a: float) -> None:
-    "Check that a - 1.0 is always less than a"
+    """Check that a - 1.0 is always less than a"""
     assert lt(a - 1.0, a) == 1.0
     assert lt(a, a - 1.0) == 0.0
 
@@ -113,15 +114,14 @@ def test_sigmoid(a: float) -> None:
 @pytest.mark.task0_2
 @given(small_floats, small_floats, small_floats)
 def test_transitive(a: float, b: float, c: float) -> None:
-    "Test the transitive property of less-than (a < b and b < c implies a < c)"
+    """Test the transitive property of less-than (a < b and b < c implies a < c)"""
     # TODO: Implement for Task 0.2.
     raise NotImplementedError("Need to implement for Task 0.2")
 
 
 @pytest.mark.task0_2
 def test_symmetric() -> None:
-    """
-    Write a test that ensures that :func:`minitorch.operators.mul` is symmetric, i.e.
+    """Write a test that ensures that :func:`minitorch.operators.mul` is symmetric, i.e.
     gives the same value regardless of the order of its input.
     """
     # TODO: Implement for Task 0.2.
@@ -130,8 +130,7 @@ def test_symmetric() -> None:
 
 @pytest.mark.task0_2
 def test_distribute() -> None:
-    r"""
-    Write a test that ensures that your operators distribute, i.e.
+    r"""Write a test that ensures that your operators distribute, i.e.
     :math:`z \times (x + y) = z \times x + z \times y`
     """
     # TODO: Implement for Task 0.2.
@@ -140,9 +139,7 @@ def test_distribute() -> None:
 
 @pytest.mark.task0_2
 def test_other() -> None:
-    """
-    Write a test that ensures some other property holds for your functions.
-    """
+    """Write a test that ensures some other property holds for your functions."""
     # TODO: Implement for Task 0.2.
     raise NotImplementedError("Need to implement for Task 0.2")
 
@@ -168,8 +165,7 @@ def test_zip_with(a: float, b: float, c: float, d: float) -> None:
     lists(small_floats, min_size=5, max_size=5),
 )
 def test_sum_distribute(ls1: List[float], ls2: List[float]) -> None:
-    """
-    Write a test that ensures that the sum of `ls1` plus the sum of `ls2`
+    """Write a test that ensures that the sum of `ls1` plus the sum of `ls2`
     is the same as the sum of each element of `ls1` plus each element of `ls2`.
     """
     # TODO: Implement for Task 0.3.