Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor FF folder structure #780

Open
isaacmg opened this issue Aug 13, 2024 · 6 comments
Open

Refactor FF folder structure #780

isaacmg opened this issue Aug 13, 2024 · 6 comments
Assignees

Comments

@isaacmg
Copy link
Collaborator

isaacmg commented Aug 13, 2024

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
--

@wizaye
Copy link

wizaye commented Oct 8, 2024

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

@isaacmg
Copy link
Collaborator Author

isaacmg commented Oct 9, 2024

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

@wizaye
Copy link

wizaye commented Oct 9, 2024

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

@isaacmg
Copy link
Collaborator Author

isaacmg commented Oct 10, 2024

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

@wizaye
Copy link

wizaye commented Oct 10, 2024

@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 ! :)

@isaacmg
Copy link
Collaborator Author

isaacmg commented Oct 10, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants