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

001 Refactor ModelPath and EnsemblePath to ModelPathManager and EnsemblePathManager #3

Closed
11 tasks done
smellycloud opened this issue Dec 11, 2024 · 0 comments · Fixed by #4
Closed
11 tasks done
Assignees
Labels
enhancement Improvements or optimizations

Comments

@smellycloud
Copy link
Collaborator

smellycloud commented Dec 11, 2024

Title

Rename ModelPath and EnsemblePath to ModelPathManager and EnsemblePathManager respectively, and refactor related tools into separate files.

Description

This issue aims to rename the ModelPath and EnsemblePath classes to ModelPathManager and EnsemblePathManager respectively. Additionally, it proposes moving model and ensemble related tools into their own files for better organization and maintainability.

Motivation

This change is necessary to improve the clarity and organization of the codebase. By renaming the classes and separating the tools into distinct files, it will be easier for developers to understand and maintain the code. This will also help in avoiding potential naming conflicts and improve the overall structure of the project.

Proposed Solution

  1. Rename ModelPath to ModelPathManager and EnsemblePath to EnsemblePathManager.
  2. Move model-related tools to a new file model.py.
  3. Move ensemble-related tools to a new file ensemble.py.
  4. Update imports across the codebase to reflect these changes. For example:
from views_pipeline_core.managers.model import ModelPathManager, ModelManager
from views_pipeline_core.managers.ensemble import EnsemblePathManager, EnsembleManager

Instead of the existing solution:

from views_pipeline_core.managers.model_manager import ModelManager
from views_pipeline_core.managers.ensemble_manager import EnsembleManager
from views_pipeline_core.managers.path_manager import ModelPath, EnsemblePath

Alternatives Considered

No alternative solutions were considered as this change is straightforward and necessary for improving code organization.

Additional Context

  • Ensure that all references to ModelPath and EnsemblePath are updated in the codebase, including documentation and comments.
  • Verify that all tests pass after making these changes.

Checklist

  • I have searched for existing feature requests that might be related to this one.
  • I have provided a detailed description of the feature request.
  • I have included all necessary information about the motivation and proposed solution.
  • I have attached relevant diagrams, mockups, or code snippets.

Actionable Tasks

  • Rename ModelPath to ModelPathManager.
  • Rename EnsemblePath to EnsemblePathManager.
  • Move model-related tools to model.py.
  • Move ensemble-related tools to ensemble.py.
  • Update imports across the codebase.
  • Update tests to reflect these changes.
  • Update the views-stepshifter package and views-models repository. Specifically the main.py files.

Branch

  • Work on a new branch named feature_001_refactor_managers
@smellycloud smellycloud added the enhancement Improvements or optimizations label Dec 11, 2024
@smellycloud smellycloud changed the title Refactor ModelPath and EnsemblePath to ModelPathManager and EnsemblePathManager 003 Refactor ModelPath and EnsemblePath to ModelPathManager and EnsemblePathManager Dec 11, 2024
@smellycloud smellycloud changed the title 003 Refactor ModelPath and EnsemblePath to ModelPathManager and EnsemblePathManager 001 Refactor ModelPath and EnsemblePath to ModelPathManager and EnsemblePathManager Dec 11, 2024
@smellycloud smellycloud linked a pull request Dec 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements or optimizations
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants