aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles <sircharlesaze@gmail.com>2020-01-23 14:39:15 +0100
committerCharles <sircharlesaze@gmail.com>2020-01-23 14:41:33 +0100
commitb21e6642c591962974212be2dbc965793df6bd06 (patch)
tree288785140417770e5e985efcaff3c48d6f9bdd64 /README.md
parent4537bdbebb5fe64c50080e7874d407f10a0676b7 (diff)
downloadft_linear_regression-b21e6642c591962974212be2dbc965793df6bd06.tar.gz
ft_linear_regression-b21e6642c591962974212be2dbc965793df6bd06.tar.bz2
ft_linear_regression-b21e6642c591962974212be2dbc965793df6bd06.zip
Fixing Model, still normalization problem
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/README.md b/README.md
index 6bde654..bf5871b 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,31 @@
ft\_linear\_regression project of school 42
-# Explaination
+## Usage
-Check out the jupyter notebook, markdown version [here](./notebook/ft_linear_regression_notebook.md).
+```
+cd src
+python cli.py --help
+```
+
+### Train model
+
+```
+python cli.py train
+```
+
+### Output model cost
+
+```
+python cli.py cost
+```
+
+### Plot model and dataset
+
+```
+python cli.py plot
+```
+
+## Notebook
+
+Check out the jupyter notebook where I try to explain the algorithm [here](./ft_linear_regression_notebook.ipynb).