merge.

Author: v0lta

.flake8

@@ -4,17 +4,24 @@
 #########################
 [flake8]
 ignore =
-    S101 # asserts are ok when testing.
-    S301 # pickle
-    S403 # pickle
+    # asserts are ok when testing.
+    S101
+    # pickle
+    S301
+    # pickle
+    S403
     S404
     S603
-    W503 # Line break before binary operator (flake8 is wrong)
-    E203 # Ignore the spaces black puts before columns.
-    E402 # allow path extensions for testing.
+    # Line break before binary operator (flake8 is wrong)
+    W503
+    # Ignore the spaces black puts before columns.
+    E203
+    # allow path extensions for testing.
+    E402
     DAR101
     DAR201
-    N400 # flake and pylance disagree on linebreaks in strings.
+    # flake and pylance disagree on linebreaks in strings.
+    N400
 exclude =
     .tox,
     .git,
@@ -34,4 +41,4 @@ max-complexity = 20
 import-order-style = pycharm
 application-import-names =
     seleqt
-    tests
+    tests

README.md

@@ -16,7 +16,7 @@ The problem is illustrated below:
 ![parabola_task](./figures/parabola_task.png)
 
 
-- Next we consider a paraboloid, $\cdot$ denots the scalar product,
+- Next we consider a paraboloid, $\cdot$ denotes the scalar product,
 
 $$ \min_{\mathbf{x}} \mathbf{x} \cdot \mathbf{x},  \text{   with   } \mathbf{x_0} = (2.9, -2.9) .$$
 
@@ -27,7 +27,7 @@ Once more the problem is illustrated below:
 ![paraboloid_task](./figures/paraboloid_task.png)
 
 
-- Additionally we consider a bumpy paraboloid, $\cdot$ denots the scalar product,
+- Additionally we consider a bumpy paraboloid, $\cdot$ denotes the scalar product,
 
 $$ \min_{\mathbf{x}} \mathbf{x} \cdot \mathbf{x} + \cos(2  \pi x_0) + \sin(2 \pi x_1 ), \text{   with   } \mathbf{x_0} = (2.9, -2.9) .$$
 

requirements.txt

@@ -1,4 +1,4 @@
 nox
 numpy
 matplotlib
-torch
+torch

src/optimize_2d_momentum_bumpy.py

@@ -64,7 +64,7 @@ def bumpy_grad(pos: np.ndarray) -> np.ndarray:
     step_total = 1  # TODO: Choose the total number of steps.
 
     pos_list = [start_pos]
-    grad = np.array((0.0, 0.0))
+    velocity_vec = np.array((0.0, 0.0))
     # TODO implement gradient descent with momentum.
 
     for pos in pos_list:

src/optimize_2d_momentum_bumpy_torch.py

@@ -57,7 +57,7 @@ def bumpy_function(pos: th.Tensor) -> th.Tensor:
     step_total = 100
 
     pos_list = [start_pos]
-    grad = np.array((0.0, 0.0))
+    velocity_vec = np.array((0.0, 0.0))
     # TODO: Implement gradient descent with momentum.
 
     for pos in pos_list:

src/util.py

@@ -26,8 +26,19 @@ def write_movie(
         name (str, optional): The name of the movie file. Defaults to "grad_movie".
         xlim (int, optional): Largest x value in the data. Defaults to 3.
         ylim (int, optional): Largest y value in the data. Defaults to 3.
+    
+    Raises:
+        RuntimeError: If conda ffmpeg package is not installed.
     """
-    ffmpeg_writer = manimation.writers["ffmpeg"]
+    try:
+        ffmpeg_writer = manimation.writers["ffmpeg"]
+    except RuntimeError:
+        raise RuntimeError(
+            "RuntimeError: If you are using anaconda or miniconda there might "
+            "be a missing package named ffmpeg. Try installing it with "
+            "'conda install -c conda-forge ffmpeg' in your terminal."
+        )
+
     metadata = dict(
         title="Gradient descent", artist="Matplotlib", comment="Minimization movie!"
     )

tests/test_function.py

@@ -70,7 +70,7 @@ def test_grad_parabola(pos):
         np.array((2.9, 2.9)),
     ),
 )
-def test_gard_paraboloid(pos):
+def test_grad_paraboloid(pos):
     """Test the paraboloid gradient."""
     nabla_x = grad_paraboloid(pos)
     fd_nabla_x = finite_difference(paraboloid, pos)