Skip to content

Commit a9290ba

Browse files
authored
Refactor parameter documentation in mini_batch_gradient_descent.py
Updated parameter documentation format in mini_batch_gradient_descent.py.
1 parent f3a8909 commit a9290ba

1 file changed

Lines changed: 8 additions & 16 deletions

File tree

machine_learning/mini_batch_gradient_descent.py

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,17 @@ def mini_batch_gradient_descent(
2222
2323
Parameters
2424
----------
25-
feature_matrix : np.ndarray
26-
Feature matrix.
27-
target_values : np.ndarray
28-
Target values.
29-
learning_rate : float
30-
Learning rate.
31-
batch_size : int
32-
Size of mini-batches.
33-
n_epochs : int
34-
Number of training epochs.
35-
random_seed : int | None
36-
Random seed for reproducibility.
25+
feature_matrix: Feature matrix.
26+
target_values: Target values.
27+
learning_rate: Learning rate.
28+
batch_size: Size of mini-batches.
29+
n_epochs: Number of training epochs.
30+
random_seed: Random seed for reproducibility.
3731
3832
Returns
3933
-------
40-
weights : np.ndarray
41-
Learned weights.
42-
bias : float
43-
Learned bias.
34+
weights: Learned weights.
35+
bias: Learned bias.
4436
4537
Example
4638
-------

0 commit comments

Comments
 (0)