Skip to content

Rafael/bump v3.0.0rc1#189

Open
rafaelpadilla wants to merge 212 commits intopetrobras:mainfrom
rafaelpadilla:rafael/bump_v3.0.0rc1
Open

Rafael/bump v3.0.0rc1#189
rafaelpadilla wants to merge 212 commits intopetrobras:mainfrom
rafaelpadilla:rafael/bump_v3.0.0rc1

Conversation

@rafaelpadilla
Copy link
Copy Markdown
Contributor

Overview

This PR introduces a new architecture and updates notebooks across the 3W Toolkit. It replaces the core structure with a simpler, more developer-friendly architecture, making it easier for contributors to create and integrate new components.

Given the scope of these changes, we suggest releasing this as version 3.0.0.

Key points:

  • Clear separation of layers and modules/
  • Kept the modular pipeline (based on v2):
    • datasetpreprocessingfeature_extractionmodelstrainingassessmentdata_visualization
  • Configuration-driven design using Pydantic (based on v2)
  • Extensible base classes for easy plug-in of new components

This change defines version 3.0.0, making the toolkit more flexible, modular, and easier to develop with.

All notebooks in the collaboration scope were updated to reflect and demonstrate examples using the new architecture.


Summary of Changes

1. Updated Toolkit Structure

  • Updated package structure to improve separation of responsibilities:

    • assessment/
    • clustering/
    • core/
    • data_loader/
    • data_visualization/
    • dataset/
    • feature_extraction/
    • metrics/
    • models/
    • preprocessing/
    • reports/
    • trainer/
    • utils/
  • Unified structure references across documentation


2. Unified Architecture for Contributors

  • One clear architecture model:

    • Base classes for extension
    • Pipeline separation of responsibilities
    • Configuration-first approach (Pydantic)
  • Standard way to add new components (configs + base classes)

  • Cleaner docstrings with explicit typing to support auto-generated documentation


3. Consistency Across Documentation and Notebooks

  • Unified terminology
  • Removed duplicated or conflicting descriptions
  • Single source of truth for architecture
  • Notebooks demonstrating the toolkit reflect the new architecture

Final Notes

This update sets a clear and modern architecture for the 3W Toolkit:

  • Matches the real package structure
  • Supports modular and extensible development
  • Makes onboarding easier

Version 3.0.0 marks a cleaner, more scalable foundation for the toolkit.

Thank you for reviewing this delivery.
🚀🥳🎊✨🎉


By creating this pull request, I confirm that I have read and fully accept and agree with one of the Petrobras' Contributor License Agreements (CLAs):

Our CLAs are based on the Apache Software Foundation's CLAs:

Mathtzt and others added 30 commits December 23, 2025 11:54
…n models classes, refactoring ModelAssessment and fixing minor issues.
…ining and forecasting strategies. Other improvements.
thadeuluiz and others added 30 commits April 15, 2026 12:47
…adilla/3W into eduardo/refactor_data_operations
…lti-class inputs with label binarization (one-hot)
…tions

Refactor of data operations, trainers and models.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants