proper formatting of predict docs

elixir-nx · Jul 28, 2024 · 88066fd · 88066fd
1 parent af993d7
commit 88066fd
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 7 deletions.
diff --git a/lib/scholar/linear/bayesian_ridge_regression.ex b/lib/scholar/linear/bayesian_ridge_regression.ex
@@ -428,7 +428,8 @@ defmodule Scholar.Linear.BayesianRidgeRegression do
 
   @doc """
   Makes predictions with the given `model` on input `x`.
-  Output predictions have shape {n_samples} when train target is shaped either {n_samples} or {n_samples, 1}.
+  
+  Output predictions have shape `{n_samples}` when train target is shaped either `{n_samples}` or `{n_samples, 1}`.
 
   ## Examples
 

diff --git a/lib/scholar/linear/isotonic_regression.ex b/lib/scholar/linear/isotonic_regression.ex
@@ -201,7 +201,8 @@ defmodule Scholar.Linear.IsotonicRegression do
 
   @doc """
   Makes predictions with the given `model` on input `x` and interpolating `function`.
-  Output predictions have shape {n_samples} when train target is shaped either {n_samples} or {n_samples, 1}.
+
+  Output predictions have shape `{n_samples}` when train target is shaped either `{n_samples}` or `{n_samples, 1}`.  
   Otherwise, predictions match train target shape.
 
   ## Examples

diff --git a/lib/scholar/linear/linear_regression.ex b/lib/scholar/linear/linear_regression.ex
@@ -116,7 +116,8 @@ defmodule Scholar.Linear.LinearRegression do
 
   @doc """
   Makes predictions with the given `model` on input `x`.
-  Output predictions have shape {n_samples}, when train target is shaped either {n_samples} or {n_samples, 1}.
+
+  Output predictions have shape `{n_samples}` when train target is shaped either `{n_samples}` or `{n_samples, 1}`.  
   Otherwise, predictions match train target shape.  
 
   ## Examples

diff --git a/lib/scholar/linear/logistic_regression.ex b/lib/scholar/linear/logistic_regression.ex
@@ -203,7 +203,8 @@ defmodule Scholar.Linear.LogisticRegression do
 
   @doc """
   Makes predictions with the given `model` on inputs `x`.
-  Output predictions have shape {n_samples}, when train target is shaped either {n_samples} or {n_samples, 1}.
+
+  Output predictions have shape `{n_samples}` when train target is shaped either `{n_samples}` or `{n_samples, 1}`.        
 
   ## Examples
 

diff --git a/lib/scholar/linear/polynomial_regression.ex b/lib/scholar/linear/polynomial_regression.ex
@@ -109,7 +109,8 @@ defmodule Scholar.Linear.PolynomialRegression do
 
   @doc """
   Makes predictions with the given `model` on input `x`.
-  Output predictions have shape {n_samples}, when train target is shaped either {n_samples} or {n_samples, 1}.
+
+  Output predictions have shape `{n_samples}` when train target is shaped either `{n_samples}` or `{n_samples, 1}`.    
   Otherwise, predictions match train target shape.  
 
   ## Examples

diff --git a/lib/scholar/linear/ridge_regression.ex b/lib/scholar/linear/ridge_regression.ex
@@ -198,7 +198,8 @@ defmodule Scholar.Linear.RidgeRegression do
 
   @doc """
   Makes predictions with the given `model` on input `x`.
-  Output predictions have shape {n_samples}, when train target is shaped either {n_samples} or {n_samples, 1}.
+
+  Output predictions have shape `{n_samples}` when train target is shaped either `{n_samples}` or `{n_samples, 1}`.        
   Otherwise, predictions match train target shape.  
 
   ## Examples

diff --git a/lib/scholar/linear/svm.ex b/lib/scholar/linear/svm.ex
@@ -250,7 +250,8 @@ defmodule Scholar.Linear.SVM do
 
   @doc """
   Makes predictions with the given model on inputs `x`.
-  Output predictions have shape {n_samples}, when train target is shaped either {n_samples} or {n_samples, 1}.
+
+  Output predictions have shape `{n_samples}` when train target is shaped either `{n_samples}` or `{n_samples, 1}`.      
 
   ## Examples
       iex> x = Nx.tensor([[1.0, 2.0], [3.0, 2.0], [4.0, 7.0]])