🚀 Project Improvements - Version Bump to 2.1.1

[rafaelpadilla]

Overview

This pull request delivers a set of fixes, refactors, and standardization efforts aimed at improving correctness, robustness, readability, and consistency across the codebase. The scope of this delivery is centered on quality improvements rather than new features.

Given the scope and impact of these improvements, this pull request suggests a bump to v2.1.1.

Summary of Changes

1. Dataset Example Cleanup and Label Consistency

Inconsistent results in dataset_examples.ipynb were investigated.

2. Git Ignore and HTML Directory Handling

The .gitignore file was updated to correctly handle the HTML directory.

3. Notebook Error Investigation and Fixes

Errors and execution issues were investigated and addressed in the following notebooks:
mlp_timeseries_example.ipynb, notebooks/feature_extraction_examples.ipynb, overview_version_2.0.0.ipynb and using_metrics.ipynb

4. Adding a new script to automate the validation of Jupyter notebooks

This delivery introduces the bin/nb_test script to automate the validation of Jupyter notebooks. The script executes all .ipynb files within a specified directory, defaulting to docs/notebooks, and fails fast if any notebook raises an error during execution. These updates ensure that the notebooks run cleanly and accurately reflect the current state of the library.

5. SSL errors related to the dataset hosted in Figshare

Fixes for SSL related errors noted in FigShare during the downloading of the dataset were addressed.

6. Replacement of Any Type Annotations

All remaining uses of the generic Any type were replaced with more specific and explicit type annotations. This improves static analysis, readability, and overall type safety across the codebase.

7. Variable Renaming for Improved Readability

Non descriptive variable names such as v and k`` were replaced with clearer, more meaningful alternatives. This improves code readability and long term maintainability.

8. Addition of Missing Docstrings in Validation Functions

All validate_ functions were reviewed and updated to include missing docstrings. The new documentation follows the established documentation style guidelines, improving clarity for users and contributors.

9. Enum Naming and Selector Standardization

Missing Enum suffixes were added where applicable to ensure consistent naming.

---

Final Notes

These changes focus on correctness, consistency, and maintainability, strengthening both the internal code quality and the reliability of user facing examples and notebooks.

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):

• ICLA: Individual Contributor License Agreement on behalf of only yourself;
• CCLA: Corporate Contributor License Agreement on behalf of your employer.

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

• ICLA: Individual Contributor License Agreement
• CCLA: Corporate Contributor License Agreement

[rafaelpadilla]

ℹ️ Info

I targeted the main branch to stay aligned with the repository default, but please feel free to change the target branch if another one is preferred. 🙏

[ricardoevvargas]

Hi, @rafaelpadilla.

I hope this PR will result in another significant contribution from the Federal University of Rio de Janeiro to the 3W Project.

We will evaluate it ASAP and will let you know here if we have any questions and/or requests for adjustments.

On behalf of the 3W Community, I thank you for this PR.