Since this PR is intended to do refactoring without changing the interface, it may be a good idea to resolve the PR that makes the test code (#66) work first.
TL;DR
This pull request addresses several key refactoring aspects related to the Features, ModelTraining, and ModelTest modules in the bdpy repository.
Summary
In this pull request, we are focusing on:
Adding type annotations: For clarity and better debugging capabilities.
Reorganizing the function call API: To reflect and streamline the existing behavior.
Raising awareness of potentially risky or unstable code sections: By commenting them out.
During the refactoring process, we encountered some functions with unclear specifications. In these cases, we have added type annotations based on inferred behavior observed in a similar context within the brain-decoding-cookbook-public repository. We believe this approach aligns well with the current project's structure and offers an effective way to handle these scenarios.
We acknowledge that this codebase has been meticulously developed over a long period, catering to a variety of use cases beyond reference implementation. Given the expansive and versatile nature of the project, there might be specific details or subtle elements we may have overlooked. Therefore, we request the project maintainers and contributors to review the proposed changes. If any discrepancies, mistakes, or alternative suggestions are found, please do not hesitate to provide feedback.
⚠️ Disclaimer (update on 6/27)
Since this PR is intended to do refactoring without changing the interface, it may be a good idea to resolve the PR that makes the test code (#66) work first.
TL;DR
This pull request addresses several key refactoring aspects related to the
Features,ModelTraining, andModelTestmodules in thebdpyrepository.Summary
In this pull request, we are focusing on:
Adding type annotations: For clarity and better debugging capabilities.
Reorganizing the function call API: To reflect and streamline the existing behavior.
Raising awareness of potentially risky or unstable code sections: By commenting them out.
During the refactoring process, we encountered some functions with unclear specifications. In these cases, we have added type annotations based on inferred behavior observed in a similar context within the
brain-decoding-cookbook-publicrepository. We believe this approach aligns well with the current project's structure and offers an effective way to handle these scenarios.We acknowledge that this codebase has been meticulously developed over a long period, catering to a variety of use cases beyond reference implementation. Given the expansive and versatile nature of the project, there might be specific details or subtle elements we may have overlooked. Therefore, we request the project maintainers and contributors to review the proposed changes. If any discrepancies, mistakes, or alternative suggestions are found, please do not hesitate to provide feedback.