Release v0.16.0: Upgrade to manylinux_2_28 and remove scipy version constraints#869
Merged
jeongyoonlee merged 3 commits intomasterfrom Feb 6, 2026
Merged
Conversation
This PR modernizes CausalML's wheel distribution by upgrading from manylinux2014 to manylinux_2_28, enabling compatibility with both scipy 1.16.x and 1.17.x without version pinning. ## Changes ### 1. Upgrade manylinux platform tag (pyproject.toml) - **Before:** manylinux2014 (glibc 2.17, CentOS 7 base - EOL June 2024) - **After:** manylinux_2_28 (glibc 2.28, modern standard) ### 2. Remove scipy version constraints - **pyproject.toml:** `scipy>=1.16.0,<1.17.0` → `scipy>=1.16.0` - **docs/environment-py311-rtd.yml:** Removed upper bound constraint - **Benefit:** Support both scipy 1.16.x and 1.17.x automatically ### 3. Document system requirements (docs/installation.rst) Added new "System Requirements" section documenting: - Python 3.11+ requirement - Minimum Linux distributions (Ubuntu 18.04+, RHEL 8+, Debian 10+) - Build-from-source instructions for older systems ## Why This Change? ### Problems with manylinux2014: - Based on CentOS 7 (EOL June 2024) - Required version pinning to avoid scipy 1.17.0 - Prevented access to newer dependency features - Maintenance burden with explicit constraints ### Benefits of manylinux_2_28: - Modern, actively maintained standard - Compatible with scipy 1.16.x AND 1.17.x - No version pinning needed - pip selects the best version - Future-proof for upcoming dependencies - Cleaner dependency declarations ## Compatibility Impact ### Systems That Work: - Ubuntu 18.04 LTS+ (glibc 2.27+) - RHEL/CentOS 8+ (glibc 2.28+) - Debian 10+ (glibc 2.28+) - All recent macOS and Windows versions ### Systems Requiring Source Build: - RHEL/CentOS 7 (glibc 2.17) - Ubuntu 16.04 and earlier - Debian 9 and earlier **Note:** CentOS 7 reached EOL in June 2024, and Ubuntu 16.04 EOL was April 2021, making this upgrade aligned with industry standards. ## scipy Compatibility CausalML uses these scipy modules: - scipy.sparse, scipy.stats - scipy.optimize (fsolve, minimize) - scipy.special (expit, logit) - scipy.interpolate (UnivariateSpline) **None of these are affected by scipy 1.17.0 breaking changes**, which only impact scipy.spatial.transform. Both scipy 1.16.x and 1.17.x work correctly with CausalML. ## Testing Pre-built wheels will now use manylinux_2_28. Users can install with either scipy version: - scipy 1.16.3 (stable, has manylinux2014 wheels) - scipy 1.17.0+ (latest, has manylinux_2_28 wheels) pip will automatically select the appropriate version based on the user's system capabilities. Supersedes: #868 (build-system fix no longer needed with manylinux_2_28) Closes: #863 Co-Authored-By: Claude (claude-sonnet-4-5) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR modernizes CausalML's wheel distribution infrastructure by upgrading from manylinux2014 (glibc 2.17) to manylinux_2_28 (glibc 2.28), and removes scipy version constraints that were previously required for manylinux2014 compatibility. The changes aim to enable support for both scipy 1.16.x and 1.17.x without version pinning, while addressing Ubuntu packaging failures documented in issues #863.
Changes:
- Upgraded manylinux platform tag from manylinux2014 to manylinux_2_28 in cibuildwheel configuration
- Removed scipy version upper bound constraint (
<1.17.0) from runtime dependencies and ReadTheDocs environment - Added system requirements documentation specifying minimum glibc and distribution versions
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| pyproject.toml | Updated manylinux images to manylinux_2_28 for x86_64 and aarch64; removed scipy upper bound from dependencies |
| docs/installation.rst | Added new System Requirements section documenting Python version, glibc requirements, and supported Linux distributions |
| docs/environment-py311-rtd.yml | Removed scipy version constraint to align with pyproject.toml changes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…t 2.27 Copilot correctly identified that Ubuntu 18.04 is NOT compatible with manylinux_2_28 wheels. Ubuntu 18.04 has glibc 2.27, but manylinux_2_28 requires glibc 2.28 or later. Changes: - Updated glibc requirement from 2.27 to 2.28 - Changed minimum Ubuntu version from 18.04 to 20.04 LTS (has glibc 2.31) - Added Ubuntu 18.04 to the list of distributions requiring source build This ensures users have accurate information about system requirements. Co-Authored-By: Claude (claude-sonnet-4-5) <noreply@anthropic.com>
Collaborator
Author
✅ Copilot Feedback AddressedThank you @copilot for catching this critical error! Issue Identified by Copilot:The documentation incorrectly stated that:
This was wrong because:
Corrections Made (commit e08981d):
Corrected Compatibility Table:
The documentation now accurately reflects that Ubuntu 20.04 LTS is the minimum version for pre-built wheels. |
|
@jeongyoonlee I've opened a new pull request, #870, to work on those changes. Once the pull request is ready, I'll request review from you. |
This release introduces breaking changes in Linux wheel compatibility due to the manylinux_2_28 upgrade, warranting a minor version bump from 0.15.6 to 0.16.0. Changes: - Updated version in pyproject.toml: 0.15.6 → 0.16.0 - Added comprehensive 0.16.0 changelog entry documenting: - Breaking change: manylinux_2_28 requirement (glibc 2.28+) - Affected systems and migration path - scipy version pin removal - Related PRs (#869, #867, #865, #864) Breaking Changes: - Pre-built wheels require Ubuntu 20.04+, RHEL 8+, Debian 10+ (glibc 2.28+) - Users on Ubuntu 18.04, RHEL 7, etc. must build from source - Python 3.11+ required (already enforced in previous release) This follows semantic versioning: minor version bump for backward- incompatible changes to wheel distribution. Co-Authored-By: Claude (claude-sonnet-4-5) <noreply@anthropic.com>
Collaborator
Author
✅ Version Bumped to 0.16.0Updated the version from 0.15.6 to 0.16.0 to reflect the breaking changes in this PR (commit 84bfead). Why a Minor Version Bump?Following semantic versioning, this PR introduces backward-incompatible changes that warrant a minor version increment: Breaking Changes:
Changelog UpdatedAdded a comprehensive 0.16.0 section to
User ImpactMost users unaffected: Modern systems (Ubuntu 20.04+, RHEL 8+) from 2020+ already meet the requirements. Affected users: Those on older systems will need to:
This version bump signals to users that upgrading may require action if they're on older systems. |
jeongyoonlee
changed the title
jeongyoonlee
requested review from
alexander-pv,
huigangchen,
paullo0106,
ppstacy,
ras44,
t-tte,
vincewu51 and
zhenyuz0500
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release v0.16.0 - Breaking Changes
This release modernizes CausalML's wheel distribution by upgrading from manylinux2014 to manylinux_2_28, enabling compatibility with both scipy 1.16.x and 1.17.x without version pinning.
Changes
1. ✅ Version Bump to 0.16.0
Minor version bump signals backward-incompatible changes in wheel distribution.
2. ✅ Upgrade manylinux platform tag
From: manylinux2014 (glibc 2.17, CentOS 7 - EOL June 2024)
To: manylinux_2_28 (glibc 2.28, modern standard)
3. ✅ Remove scipy version constraints
Files updated:
pyproject.toml(version, runtime dependencies, cibuildwheel config)docs/environment-py311-rtd.yml(ReadTheDocs build)docs/changelog.rst(0.16.0 release notes with migration guide)docs/installation.rst(system requirements documentation)4. ✅ Document breaking changes
Added comprehensive 0.16.0 changelog with:
Why This Change?
Problems with Previous Approach (manylinux2014 + pinning):
Benefits of manylinux_2_28:
Compatibility Analysis
✅ Systems That Will Work (Pre-built Wheels):
Important: manylinux_2_28 requires glibc 2.28, not 2.27. Ubuntu 18.04 has glibc 2.27, making it incompatible with pre-built wheels.
scipy Compatibility Verification
CausalML uses these scipy modules (verified via code analysis):
✅ None of these are affected by scipy 1.17.0 breaking changes
According to scipy 1.17.0 release notes, breaking changes only affect:
scipy.spatial.transformmodule (which CausalML does not use)Both scipy 1.16.x and 1.17.x work correctly with CausalML.
Migration Guide for Affected Users
If you're on Ubuntu 18.04, RHEL 7, or another older Linux distribution:
1. Check your glibc version
2. If glibc < 2.28, build from source
3. Recommended: Upgrade to modern OS
See
docs/changelog.rstfor detailed migration notes.Testing Plan
Commits
Related PRs
Documentation
docs/installation.rstwith system requirementsdocs/changelog.rstentry for 0.16.0🤖 Generated with Claude Code