Fixed sigmoid documentation.

nkoukpaizan · nkoukpaizan · commit 1d6e4ae50082 · 2025-12-12T12:15:51.000-05:00
diff --git a/GridKit/CommonMath.hpp b/GridKit/CommonMath.hpp
@@ -12,7 +12,7 @@ namespace GridKit
     /**
      * @brief Scaled sigmoid activation function
      *
-     * @note The sigmoid constant (mu) value of the constant to balance accuracy
+     * @note The sigmoid constant (mu) value is chosen to balance accuracy
      * and finite derivatives. Large values more closely approximate a step
      * function, but lead to inf or NaN derivatives. 
      * The value of 240 corresponds to a time step of 1/4 of a 60Hz cycle.

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace GridKit`
`12`	`12`	`/**`
`13`	`13`	`* @brief Scaled sigmoid activation function`
`14`	`14`	`*`
`15`		`- * @note The sigmoid constant (mu) value of the constant to balance accuracy`
	`15`	`+ * @note The sigmoid constant (mu) value is chosen to balance accuracy`
`16`	`16`	`* and finite derivatives. Large values more closely approximate a step`
`17`	`17`	`* function, but lead to inf or NaN derivatives.`
`18`	`18`	`* The value of 240 corresponds to a time step of 1/4 of a 60Hz cycle.`