&fkiraly [DOC] Add guide for module-level soft dependency imports (#7690) #8386
Conversation
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
This PR adds documentation for how to handle module-level soft dependency imports.
yarnabrina
requested changes
Jun 13, 2025
There was a problem hiding this comment.
Hi @aarsh1a thanks for your contribution.
It is recommended to rely on the python dependencies tag as much as possible, and avoid module level imports even after checks. This is to avoid possible side effects that imports may cause. In some cases we do deviate from this, mostly in our deep learning estimators, but those are specific cases and if I am not wrong we are trying to reduce those as well. Can you please update accordingly?
|
sure! i'll make the changes and update the file. |
Made specific changes that were asked for and updated the file.
|
hi @yarnabrina I made some changes to the file please take a look. |
fkiraly
requested changes
Jun 14, 2025
There was a problem hiding this comment.
Nice! Thanks!
Some requests to make it clearer:
- can you turn the content into a subsection of the previous section "handling soft dependencies", and turn part of the previous section into another subsection?
- at the start, it should be explained that (a) soft dependencies should be restricted to estimators if possible, and (b) if not possible, then the instructions in the other section should be followed
- the distribute the examples in the appropriate section
_safe_importshould also be mentioned
Addressed the changes requested.
fkiraly
reviewed
Jun 15, 2025
fkiraly
reviewed
Jun 15, 2025
fkiraly
reviewed
Jun 15, 2025
fkiraly
reviewed
Jun 15, 2025
fkiraly
reviewed
Jun 15, 2025
fkiraly
requested changes
Jun 15, 2025
|
This is abandoned, I wrapped it up now. |
ericjb
pushed a commit
to ericjb/sktime
that referenced
this pull request
Jul 31, 2025
…time#7690) (sktime#8386) This PR adds documentation for handling module-level soft dependency imports in sktime. The existing developer guide explains how to manage soft dependencies within estimators, but does not cover scenarios where optional dependencies need to be imported at the module level. To address this, I have added a new section titled "Module-level soft dependency imports" under dependencies.rst. It provides clear usage patterns for using _check_soft_dependencies before importing optional modules directly. Example code snippets are included to demonstrate both severity-based checks and conditional imports.
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.
This PR adds documentation for handling module-level soft dependency imports in sktime. The existing developer guide explains how to manage soft dependencies within estimators, but does not cover scenarios where optional dependencies need to be imported at the module level.
To address this, I have added a new section titled "Module-level soft dependency imports" under dependencies.rst. It provides clear usage patterns for using _check_soft_dependencies before importing optional modules directly. Example code snippets are included to demonstrate both severity-based checks and conditional imports.