Recommenders: [FEATURE] Reorganize the reco_utils folder
Description
I found I did not reuse some good utitilies in the repo that could have saved much work in #637 . Not sure if a new user will get lost or not, given that many relevant utility functions are scattered here and there in the reco_utils
Expected behavior with the suggested feature
- Reorganization of the
reco_utils. For instance, the utilities for Pandas splitter and Pandas DataFrame can be put together into one script? - Maybe good documentation of the utilities are needed as a reference for the users.
Other Comments
yueguoguo
All 4 comments
We discussed the documentation in some meeting. It would be quite easy to compile a documentation using sphinx and readthedocs.
miguelgfierro
on 18 Mar 2019
@miguelgfierro readthedocs is all we need 馃槃
yueguoguo
on 18 Mar 2019
I generated a branch at one point which used sphinx apidoc to generate documentation (at least for the reco_utils sub-folders). There were some concerns around how best to maintain / host the documentation though so it was not pushed forward. Maybe we should revisit it, with building / publishing docs built into the process for pushing to master?
gramhagen
on 18 Mar 2019
Agree with @gramhagen
yueguoguo
on 19 Mar 2019
Related issues
anargyri
路
3Comments
loomlike
路
5Comments
karthikraja95
路
3Comments
miguelgfierro
路
5Comments
msalvaris
路
6Comments
Most helpful comment
I generated a branch at one point which used sphinx apidoc to generate documentation (at least for the reco_utils sub-folders). There were some concerns around how best to maintain / host the documentation though so it was not pushed forward. Maybe we should revisit it, with building / publishing docs built into the process for pushing to master?