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

Refactoring of the codebase #296

Open
2 of 4 tasks
crangelsmith opened this issue Mar 1, 2024 · 0 comments
Open
2 of 4 tasks

Refactoring of the codebase #296

crangelsmith opened this issue Mar 1, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@crangelsmith
Copy link
Collaborator

crangelsmith commented Mar 1, 2024

The codebase has gotten too big and some refactoring is needed. Some ideas to address:

  • Data loading: The data loader has been extracted out into caked, in order to be able to load many more types of datasets, and from different pipelines. This simplifies what happens in data.py. Refactoring happening on Integrating Caked to Affinity #293

  • Training and evaluation: Too many things are happening in these scripts that can be moved in to its own files, so these only show the pipeline for training (Training refactoring #303):
    - Load data
    - Define model
    - Define loss function
    - Run loop for training
    - Visualise and save results.

  • Functions with too many parameters: train, eval, pass_batch, etc have too many parameters and it can get confusing and introduce bugs, we already have a a pedantic data model that can be passed around and in some cases, a class seems better than a function. Some functions can be broken into smaller parts as well.

  • Many minor bug fixes that have been opened for a while.

Please add any more ideas for refactoring, I'll keep this as a meta issue for discussion.

Before this refactoring begins I think we should merge the current version of the code to main as it that has been used to produce results for the paper.

@crangelsmith crangelsmith added the enhancement New feature or request label Mar 1, 2024
@crangelsmith crangelsmith self-assigned this Mar 1, 2024
@crangelsmith crangelsmith changed the title Refactor of the full codebase Refactor of the codebase Mar 1, 2024
@crangelsmith crangelsmith changed the title Refactor of the codebase Refactoring of the codebase Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant