search

opentensor / bittensor

Internet-scale Neural Networks
https://www.bittensor.com/
MIT License
934 stars 323 forks source link

Refactoring of the Bittensor codebase (Consider as a Epic) #1882

Closed roman-opentensor closed 1 week ago

roman-opentensor commented 6 months ago

Is your feature request related to a problem? Please describe.

The current Bittensor package lacks consistent coding standards across its various modules, which сan led to maintainability issues. This task card is for refactoring the Bittensor codebase to enhance readability, consistency, and adherence to modern Python practices.

Describe the solution you'd like

I am doing a sequential (module-based) refactoring of the Bittensor codebase. This includes ensuring compliance with Cortex standards, introducing type annotations for all functions and methods, and reorganizing the code structure to improve modularity and separation of responsibilities. This refactoring will also require updating all code documentation to reflect the changes and enhance clarity.

Special attention should be given to dividing the refactoring into:

  1. Refactoring according to RFC 003: Bittensor Coding Standards
  2. Structural and architectural changes, which will also require separate PRs.

Acceptance Criteria

  • SOW is developed, listing the Bittensor package modules in order from the least used to the most complex.
  • The document should include a detailed plan that accommodates both current and planned changes, ensuring alignment with ongoing projects and future enhancements.
  • The 'Scope of Work' document must be reviewed and approved by the development team and management to ensure that all stakeholders agree on the approach and priorities.
  • Feedback from the team and management should be incorporated to refine the refactoring plan.

Implementation Plan Update and Execution

roman-opentensor commented 6 months ago

Added https://github.com/opentensor/bittensor/pull/1896 to list