Comments

armadaproject · Feb 28, 2024 · c42c656 · c42c656
1 parent cb4b113
commit c42c656
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/internal/common/optimisation/optimisation.go b/internal/common/optimisation/optimisation.go
@@ -4,8 +4,8 @@ import "gonum.org/v1/gonum/mat"
 
 // Optimiser represents a first-order optimisation algorithm.
 type Optimiser interface {
-	// Update the parameters p using gradient g and store the result in out.
-	Update(out, p *mat.VecDense, g mat.Vector) *mat.VecDense
+	// Update the parameters using gradient and store the result in out.
+	Update(out, parameters *mat.VecDense, gradient mat.Vector) *mat.VecDense
 	// Extend the internal state of the optimiser to accommodate at least n parameters.
 	Extend(n int)
 }