Skip to content

Commit ac6d085

Browse files
committed
modify readme and changelog
1 parent 2940758 commit ac6d085

3 files changed

Lines changed: 12 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
55
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
66

7+
## Unreleased
8+
### Modified
9+
- Linear Regression, fit with gradient descent
10+
711
## [0.1.2] - 2018-11-22
812
### Added
913
- CHANGELOG.md file

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,18 @@ Initialize predictor with data:
3333
predictor = Linear.new([1, 2, 3, 4], [3, 6, 10, 15])
3434
```
3535

36-
Fit data set:
36+
Fit data set with least squares method:
3737

3838
```elixir
3939
predictor = predictor |> Linear.fit
4040
```
4141

42+
Fit data set with gradient descent method:
43+
44+
```elixir
45+
predictor = predictor |> Linear.fit([method: "gradient descent"])
46+
```
47+
4248
Predict using the linear model:
4349

4450
```elixir

lib/learn_kit/regression/linear.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ defmodule LearnKit.Regression.Linear do
4949
end
5050

5151
@doc """
52-
Fit train data with least squares method
52+
Fit train data
5353
5454
## Parameters
5555

0 commit comments

Comments
 (0)