aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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).