Skip to content

Conversation

@staskh
Copy link
Owner

@staskh staskh commented Sep 9, 2025

Overview

This PR synchronizes the IGLU-Python implementation with the latest IGLU-R v4.3.0 and includes several improvements for better compatibility and usability.

Changes Summary

🔄 IGLU-R Synchronization

  • Updated to IGLU-R v4.3.0: Synchronized with the latest development version from GitHub
  • MAG function updates: Modified MAG function to match new IGLU-R v4.3.0 behavior
    • Changed parameter n from int=60 to int|None=None to match new IGLU-R behavior
    • Updated test expectations to reflect IGLU-R v4.3.0 calculation results
  • Version bump: Updated package version from 0.2.5 to 0.3.0

🛠️ Dependency Improvements

  • Relaxed version requirements: Updated numpy and pandas version constraints to play better with other libraries (such as Databricks)
  • Better compatibility: Ensures the package works in various environments without strict version conflicts

📊 Testing & Validation

  • Updated test data: Refreshed expected results to match IGLU-R v4.3.0 output
  • New evaluation notebook: Added mag_evaluation.ipynb for comprehensive MAG function testing
  • Updated documentation: Refreshed README and evaluation notebooks with latest compatibility information

Files Changed

  • iglu_python/mag.py - Updated MAG function implementation
  • pyproject.toml - Version bump and dependency relaxation
  • tests/test_mag.py - Updated test expectations
  • tests/expected_results.json - Updated reference data
  • notebooks/mag_evaluation.ipynb - New evaluation notebook
  • README.md - Updated compatibility information
  • Various evaluation notebooks - Updated for v4.3.0 compatibility

Testing

  • ✅ All existing tests pass
  • ✅ New MAG function behavior matches IGLU-R v4.3.0
  • ✅ Compatibility verified with latest IGLU-R development version

Impact

This update ensures IGLU-Python remains fully compatible with the latest IGLU-R development version while improving overall package usability and dependency management.

Related to: #9 - Synchronise with 2025-07-12 IGLU-R implementation

- Change MAG function parameter 'n' from int=60 to int|None=None to match new IGLU-R behavior
- Update test expectations to reflect IGLU-R v4.3.0 calculation results
- Bump version to 0.3.0 to reflect compatibility with IGLU-R v4.3.0
- Add MAG evaluation notebook for testing and validation

This update ensures compatibility with the latest IGLU-R development version (4.3.0)
installed from GitHub, addressing changes in the MAG calculation algorithm.
@staskh staskh linked an issue Sep 9, 2025 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Sep 9, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.16%. Comparing base (a70cf71) to head (74174d1).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #10      +/-   ##
==========================================
+ Coverage   90.81%   91.16%   +0.34%     
==========================================
  Files          46       46              
  Lines        1764     1754      -10     
==========================================
- Hits         1602     1599       -3     
+ Misses        162      155       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@staskh staskh merged commit 8932308 into main Sep 9, 2025
3 checks passed
@staskh staskh deleted the 9-synchronise-with-2025-07-12-iglu-r-implementation branch September 9, 2025 15:49
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.

Synchronise with latest IGLU-R (4.3.0) IGLU-R version

3 participants