UBC-MDS / datascience_eda

This package includes functions helping with common tasks during EDA stage of a data science project
MIT License
0 stars 2 forks source link

Add specification for initial_clustering function and its required dependencies #11

Closed lephanthuymai closed 3 years ago

lephanthuymai commented 3 years ago

Hi Team, I have created the specification for the initial_clustering function with details as below:

  1. Add required dependencies
    poetry add pandas
    poetry add sklearn
    poetry add yellowbrick
  2. Add initial_clustering and its support function to datascience_eda.py
  3. Update HTML document using poetry run make html
  4. Build the package (to make sure my code can compile): poetry build

Notes: given the time constraint, I'm not listing Hierarchical clustering in the clustering function, I find it not as useful as the other two (K-Means and DBSCAN) anyway. The function does not return anything at the moment, I have posted a question on Slack asking how we can create tests for functions only printing things, awaiting their response.

@charlessuresh is my dedicated reviewer for this week, others please feel free to review and comment.

Thanks. Mai