flow-forecast icon indicating copy to clipboard operation
flow-forecast copied to clipboard

Refactor FF folder structure

Open isaacmg opened this issue 1 year ago • 6 comments

There are a lot of files that are misplaced in different areas which doesn't make sense. We want to create a cleaner overall code structure.

-- models -- basic_models -- transformers -- multimodal

 -- 

-- custom_operators -- loss_functions --

isaacmg avatar Aug 13 '24 19:08 isaacmg

Hey @isaacmg i would like to work on this could you assign this to me?

wizaye avatar Oct 08 '24 15:10 wizaye

Thanks for the help. I just assigned it make sure you update the relevant imports so not to cause errors.

isaacmg avatar Oct 09 '24 03:10 isaacmg

@isaacmg could you please give me the correct format to update the folder structure (or just edit the issue description), Thanks :)

wizaye avatar Oct 09 '24 04:10 wizaye

So I think the files should be organized in a better sense, but it is somewhat complicated. I think the best way is to have modeling directory, loss_and_optimizers directory, preprocessing, deployment, and plugins directory (essentially now just renamed from GCP integration). All the models should go under modeling

--- modeling
     --- basic_models
     --- transformer_models (renamed from transformer_xl)
     --- multimodal_models
--- preprocessing
     ---- dataloders

But now that I remember the imports to the ReadTheDocs will also need to be updated to reflect the new structure

isaacmg avatar Oct 10 '24 04:10 isaacmg

@isaacmg well i got it now , ill try updating the folder structure with the above format and make a pr by eod, check that out and let me know if any changes need ! :)

wizaye avatar Oct 10 '24 04:10 wizaye

Actually it might be easier for you to start with the docstrings as that is fairly simple and self contained (you can start with just a few files there). This is probably actually easier to do with the PyCharm IDE using refactor which will change the paths automatically. Also it will likely create a large merge conflict due to the sheer number of files and directories changed with respect to other branches so will need to be merged fairly fast or else there will be a lot of commit issues to manually resolve and fix.

isaacmg avatar Oct 10 '24 04:10 isaacmg