Module Development, changed doc string as required, two new Jupyter notebooks #5
Conversation
KMeans.py
Outdated
| Function that helps to determine how many clusters to use by using trials of K clusters | ||
| The idea is to find the cluster number that gives the maximum reduction in inertia | ||
| ''' | ||
| def elbow_method(data, num_k, n_init=10, max_iter=300): |
There was a problem hiding this comment.
considering adding "saving the generated elbow plot" option ; (i.e. pass another argument "save" with default save = False )
KMeans.py
Outdated
| from sklearn.cluster import KMeans | ||
| from sklearn.datasets import make_blobs | ||
|
|
||
| ''' |
There was a problem hiding this comment.
please refer to the style guide for the conventions we are hoping to follow (https://numpydoc.readthedocs.io/en/latest/format.html#short-summary). block comments below def statement
LinearRegression.py
Outdated
| import numpy as np | ||
| import matplotlib.pyplot as plt | ||
|
|
||
| ''' |
There was a problem hiding this comment.
refer to KMeans.py for annotations on code conventions we want to follow
MuhangTian
changed the title
|
Added two ML Jupyter notebooks, one with ML regression and the other with unsupervised clustering functions from scikit-learn |
README.md
Outdated
| # ML Models | ||
| * See jupyter notebooks, it contains everything the user need to know in the doc strings |
There was a problem hiding this comment.
maybe a link to the jupyter notebook would be more intuitive for the users :)
ml_regression.ipynb
Outdated
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "class LinearRegression():\n", |
There was a problem hiding this comment.
If class is already defined as another py file, I would import and call instead of having another cell.
ml_regression.ipynb
Outdated
| @@ -0,0 +1,347 @@ | |||
| { | |||
There was a problem hiding this comment.
As these are more function definitions (or class as you are creating), I would have created a ml_regression.py file, and define them there. I think we envision Jupyter notebooks to be used as sample codes/visualization of how your functions work :)
README.md
Outdated
| # ML Models | ||
| * See jupyter notebooks, it contains everything the user need to know in the doc strings |
There was a problem hiding this comment.
consider putting a link for the users-- probably more intuitive 💡
unsupervised_clustering.ipynb
Outdated
| @@ -0,0 +1,187 @@ | |||
| { | |||
There was a problem hiding this comment.
As commented on ml_regression.ipynb, could we have this as another py file.
Finished T-test and relevant tutorial for T-test.py