Restructure of MLTSA repo #15
Description
Per pedro's idea, the project management of MLTSA repository should be strengthen, by restructing the files in MLTSA repo.
Following the basic blueprint of aim analysis, this issue would discuss the following things:
- What: To enhance the management of MLTSA project, which would yield a better layout for users and readers of MLTSA paper whom has been linked to this repo from the paper.
- For pacakage using: The structure of importing should keep shallow, a deep structure is bad for api design, exmpale:
from MLTSA import dataset, then usedataset.functions, avoid deep importing structure asfrom MLTSA.dataset.twoDdata.generator import ... - For package developing: change log and readme file should be updated from time to time, to let users and other developers be aware of project management status clearly
- For paper reference: A notebook folder would be ideal container having example code in it, as showing proper supporting examples for the readers who jumped to this repo from the paper published, if possible, it would be fine for keeping the example code unchanged using github archive(which yield a new repo) or create a new branch to store the example code which used in the paper.
- Who: Pedro and zwei21 would be discuss and work on this issue together
- Where: The whole project repo file structure should be considered to restructure
- How:
- Pedro has suggested a python package called "cookiecutter" which would automatically generate file directory with respect to defined templates. Few templates suitable for deep learning projects has been recommended by Pedro. However, this method would generate brand new directory which means the origional file of MLTSA would be totally moved and transferred to the new directory, can't say if this would consume more time or cost.
- Zwei21 suggest amend the current file directory accoring to the given repo templates, which would be less difficult since there are few folders that could be reused in the new structure, however, this requires reconsidering the MLTSA repo current structure and rearranging code already build, problems like importing structure in current files would occur when this plan is merging. A good understanding of whole MLTSA structure should be considered well for this plan; in this reason, zwei sugguest that comment and document all the current code and files before the reconstruction, like making an inventory report before rebasing the warehouse.
- When: This should be done no later than end of August, 2022, from when zwei21 would leave UCL and all incomplete projects would be difficult to finish.