Skip to content

[MNT] Address lapsed pytorch-tabnet dependency with warnings and migration guide[MNT] Address lapsed pytorch-tabnet dependency with warnings and migration guidefeat: handle lapsed tabnet dependency with warnings and migration guide#659

Open
SHIVANSH-ux-ys wants to merge 1 commit into
pytorch-tabular:mainfrom
SHIVANSH-ux-ys:fix-tabnet-dependency

Conversation

@SHIVANSH-ux-ys
Copy link
Copy Markdown

Summary

This PR addresses the lapsed maintenance status of the pytorch-tabnet soft dependency (Issue #611). It introduces proactive runtime warnings and a comprehensive migration guide to assist users in transitioning to more stable and actively maintained architectures.

Rationale

As identified by the maintainers in Issue #611, pytorch-tabnet has not received updates since early 2023. To ensure the long-term stability of the PyTorch Tabular ecosystem and protect users from future compatibility breaks with PyTorch/Lightning updates, a "soft" deprecation path is necessary. This PR implements this by notifying users at runtime and providing a clear path forward.

Fixes

Fixes #611

Key Changes

  • Runtime Warnings: Injected a FutureWarning in TabNetModel.__init__ to notify users of the unmaintained dependency status.
    • Migration Guide: Authored docs/migration_guides/tabnet_migration.md which highlights modern, high-performance alternatives like GANDALF and FT-Transformer.
    • Project Transparency: Updated the README.md and Available Models section to flag the TabNet status and link directly to the migration documentation.

@SHIVANSH-ux-ys
Copy link
Copy Markdown
Author

Hi @manujosephv, just a quick follow-up on this. I've addressed the TabNet dependency issues and included a migration guide as discussed. Whenever you have a moment, could you please approve the CI runs so we can make sure everything is passing on the build side? Happy to tackle any feedback once the tests are green.

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.

[ENH] deal with pytorch-tabnet lapsed soft dependency

1 participant