Add documentation

nada_ai/linear_model/linear_regression.py

@@ -45,6 +45,10 @@ def __init__(
     ) -> None:
         """
         Initialization.
+        NOTE: this model will produce logistic regression logits instead of
+        the actual output probabilities!
+        To convert logits to probabilities, they need to be passed through a
+        sigmoid activation function.
 
         Args:
             in_features (int): Number of input features to regression.
@@ -57,6 +61,10 @@ def __init__(
     def forward(self, x: na.NadaArray) -> na.NadaArray:
         """
         Forward pass.
+        NOTE: this forward pass will return the logistic regression logits instead
+        of the actual output probabilities!
+        To convert logits to probabilities, they need to be passed through a
+        sigmoid activation function.
 
         Args:
             x (na.NadaArray): Input array.