search

adonis-wyc / housingrecommendation

MIT License
0 stars 1 forks source link

Feedback on final presentation #7

Open joseph-hellerstein opened 4 years ago

joseph-hellerstein commented 4 years ago

Very reasonable functional and design documents. Repo Project name and code folder should be the same. So change folder “housing_rec” to housingrecommendation?

README.md shows how to use the tool

Notebooks in package directory, e.g machine learning data prepare for the house price.ipynb in housingrecommendation/house_rec/code/ml/

Should not have “-” in file names (e.g., examples notebooks)

Reasonable examples in jupyter notebooks.

Has continuous integration

Submodules, e.g. housingrecommendation/house_rec/code/ml/ doesn’t appear to be setup to be imported

No use of functions in housingrecommendation/house_rec/code/ml/ Unit tests just test the https://github.com/adonis-wyc/housingrecommendation/blob/master/house_rec/code/htmlserver/datahandle.py and no other files

Submodule init.py always imports os and sys but they are never used.

Setup.py is barebones and should probably have a better package description than ‘first version’ (spelled incorrectly)

Many files lack module and function level documentation.

Anthony2018 commented 4 years ago

for the repo, we change the name of file to have same name with repo. for the notebooks in package, we have move them to the example document. and ml is not our submodule, we do the prediction in Notebooks and put the result model in front-end to achieve fast runtime in web. sorry for misleading.

Anthony2018 commented 4 years ago

update the setup.py by more in information

Anthony2018 commented 4 years ago

update the init.py and submodule misleading problem