From e21c92a4c619506af6aa05092bd6105f171883b9 Mon Sep 17 00:00:00 2001 From: Mathias Leys Date: Fri, 14 Jun 2024 10:14:59 +0100 Subject: [PATCH] Add documentation --- nada_ai/linear_model/linear_regression.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/nada_ai/linear_model/linear_regression.py b/nada_ai/linear_model/linear_regression.py index 8aa5c75..3ad553e 100644 --- a/nada_ai/linear_model/linear_regression.py +++ b/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.