fix typos in docs

tum-pbs · Nov 6, 2024 · 5f4323a · 5f4323a
1 parent dad1d74
commit 5f4323a
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -101,7 +101,7 @@ for input_i in dataset:
         loss_i.backward()
         grads.append(get_gradient_vector(network)) #get loss-specfic gradient
     g_config=ConFIG_update(grads) # calculate the conflict-free direction
-    apply_gradient_vector(network) # set the condlict-free direction to the network
+    apply_gradient_vector(network,g_config) # set the condlict-free direction to the network
     optimizer.step()
 ```
 

diff --git a/conflictfree/grad_operator.py b/conflictfree/grad_operator.py
@@ -45,7 +45,7 @@ def ConFIG_update_double(
                 loss_i.backward()
                 grads.append(get_gradient_vector(network)) #get loss-specfic gradient
             g_config=ConFIG_update_double(grads) # calculate the conflict-free direction
-            apply_gradient_vector(network) # set the condlict-free direction to the network
+            apply_gradient_vector(network,g_config) # set the condlict-free direction to the network
             optimizer.step()
         ```
 
@@ -119,7 +119,7 @@ def ConFIG_update(
                 loss_i.backward()
                 grads.append(get_gradient_vector(network)) #get loss-specfic gradient
             g_config=ConFIG_update(grads) # calculate the conflict-free direction
-            apply_gradient_vector(network) # set the condlict-free direction to the network
+            apply_gradient_vector(network,g_config) # set the condlict-free direction to the network
             optimizer.step()
         ```
     """
@@ -231,7 +231,7 @@ class ConFIGOperator(GradientOperator):
                 loss_i.backward()
                 grads.append(get_gradient_vector(network))
             g_config=operator.calculate_gradient(grads) # calculate the conflict-free direction
-            apply_gradient_vector(network) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
+            apply_gradient_vector(network,g_config) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
             optimizer.step()
         ```
 

diff --git a/conflictfree/momentum_operator.py b/conflictfree/momentum_operator.py
@@ -171,7 +171,7 @@ class PseudoMomentumOperator(MomentumOperator):
             loss_i.backward()
             grads.append(get_gradient_vector(network))
         g_config=operator.calculate_gradient(grads) # calculate the conflict-free direction
-        apply_gradient_vector(network) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
+        apply_gradient_vector(network,g_config) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
         optimizer.step()
     ```
     """

diff --git a/docs/start/start.md b/docs/start/start.md
@@ -36,7 +36,7 @@ for input_i in dataset:
         loss_i.backward()
         grads.append(get_gradient_vector(network)) #get loss-specfic gradient
     g_config=ConFIG_update(grads) # calculate the conflict-free direction
-    apply_gradient_vector(network) # set the condlict-free direction to the network
+    apply_gradient_vector(network,g_config) # set the condlict-free direction to the network
     optimizer.step()
 ```
 
@@ -55,7 +55,7 @@ for input_i in dataset:
         loss_i.backward()
         grads.append(get_gradient_vector(network))
     g_config=operator.calculate_gradient(grads) # calculate the conflict-free direction
-    apply_gradient_vector(network) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
+    apply_gradient_vector(network,g_config) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
     optimizer.step()
 ```
 
@@ -78,7 +78,7 @@ for input_i in dataset:
         loss_i.backward()
         grads.append(get_gradient_vector(network))
     g_config=operator.calculate_gradient(grads) # calculate the conflict-free direction
-    apply_gradient_vector(network) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
+    apply_gradient_vector(network,g_config) # or simply use `operator.update_gradient(network,grads)` to calculate and set the condlict-free direction to the network
     optimizer.step()
 ```
 

diff --git a/pypi_desc.md b/pypi_desc.md
@@ -103,7 +103,7 @@ for input_i in dataset:
         loss_i.backward()
         grads.append(get_gradient_vector(network)) #get loss-specfic gradient
     g_config=ConFIG_update(grads) # calculate the conflict-free direction
-    apply_gradient_vector(network) # set the condlict-free direction to the network
+    apply_gradient_vector(network,g_config) # set the condlict-free direction to the network
     optimizer.step()
 ```