feat: throwing a warning when a sub-backend implementation is available but is not being used. #23489

Madjid-CH · 2023-09-12T22:00:49Z

PR Description

This PR is for this task
my solution is to:

during the backend setting ivy.set_backend I check available sub-backend implementations by analyzing the sub backend module and put the result in a dictionary.
inside the _set_backend_as_ivy I check if a given symbols has a sub backend implementation from the already populated dictionary in step 1 and if this the case we wrap the function with a wrapper that throws a warning when ever the function is used.

there's an issue which is I need to import the ivy sub backend (for example this) dynamically and analyze it symbols to do step 1 this may lead to some errors if the real sub backend(for example this) is not installed properly (missing some cuda toolkits or something like that) so either we catch the error and abort the search or we search the sub backend module without importing it (some sort of static analysis) but I didn't find a way to do the later.

…b_backend_handler.py.

…_implementation_available_but_not_used task.

…arn_efficient_implementation_available if necessary

…e a real warning instead of logging it.

…ion_available_but_not_used is now passing.

…ble.py

github-actions · 2023-09-12T22:02:55Z

Thanks for contributing to Ivy! 😊👏
Here are some of the important points from our Contributing Guidelines 📝:
1. Feel free to ignore the run_tests (1), run_tests (2), … jobs, and only look at the display_test_results job. 👀 It contains the following two sections:
- Combined Test Results: This shows the results of all the ivy tests that ran on the PR. ✔️
- New Failures Introduced: This lists the tests that are passing on main, but fail on the PR Fork. Please try to make sure that there are no such tests. 💪
2. The lint / Check formatting / check-formatting tests check for the formatting of your code. 📜 If it fails, please check the exact error message in the logs and fix the same. ⚠️🔧
3. Finally, the test-docstrings / run-docstring-tests check for the changes made in docstrings of the functions. This may be skipped, as well. 📚
Happy coding! 🎉👨‍💻

vedpatwardhan

Hey @Madjid-CH, just requested a few changes, thanks 😄

ivy/func_wrapper.py

ivy/utils/backend/handler.py

ivy/utils/backend/sub_backend_handler.py

…for non-compositional functions

github-actions

PR Compliance Checks

Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.

Issue Reference

In order to be considered for merging, the pull request description must refer to a specific issue number. This is described in our contributing guide and our PR template.
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this PR is meant to address.

…backend_handler.py to avoid failing tests

vedpatwardhan

Just requested a few more changes, thanks @Madjid-CH 😄

ivy/utils/backend/handler.py

ivy/utils/backend/sub_backend_handler.py

…ssing fn_name directly

vedpatwardhan

Almost there, just a minor change, thanks @Madjid-CH 😄

ivy/utils/backend/sub_backend_handler.py

vedpatwardhan

Hey @Madjid-CH, just a couple more comments, thanks 😄

ivy/utils/backend/handler.py

ivy/utils/backend/sub_backend_handler.py

…ntation # Conflicts: # ivy/utils/backend/sub_backend_handler.py

ivy/utils/backend/sub_backend_handler.py

ivy/utils/backend/handler.py

… _find_available_sub_backends_dict

vedpatwardhan

Just a minor change, thanks @Madjid-CH 😄

ivy/utils/backend/sub_backend_handler.py

…ion.

vedpatwardhan

lgtm! Feel free to merge, thanks @Madjid-CH 😄

…tation is available but is not being used. (ivy-llc#23489)

Madjid-CH and others added 9 commits September 4, 2023 11:38

fix: replaced deprecated logging.warn call with logging.warning in su…

a0b1010

…b_backend_handler.py.

feat(Ivy Framework):started working on throw_warning_when_sub_backend…

7c18158

…_implementation_available_but_not_used task.

fix(tests): fixed failing test_sub_backend_implementation_available

c750974

refactor(sub_backend_handler)

a486df9

feat(func_wrapper) added efficient_implementation_available decorator.

56ec27c

feat(backend handler): made the set_backend wrap the function with _w…

df0e0fe

…arn_efficient_implementation_available if necessary

fix(func_wrapper): made _warn_efficient_implementation_available rais…

6c5bebe

…e a real warning instead of logging it.

fix(backend handler): test_throw_warning_when_sub_backend_implementat…

ae8c14b

…ion_available_but_not_used is now passing.

refactor(tests): renamed test_sub_back.py to test_sub_backends_availa…

401e895

…ble.py

Madjid-CH requested review from vedpatwardhan and CatB1t as code owners September 12, 2023 22:00

ivy-seed assigned D0m-inic Sep 12, 2023

vedpatwardhan suggested changes Sep 13, 2023

View reviewed changes

refactored sub_backend_handler.py and added sub backend verification …

5f414e0

…for non-compositional functions

github-actions bot reviewed Sep 13, 2023

View reviewed changes

Madjid-CH changed the title ~~Throwing a warning when a sub-backend implementation is available but is not being used.~~ feat: throwing a warning when a sub-backend implementation is available but is not being used. Sep 13, 2023

refactored sub_backend_handler.py reintroduce _check_callable in sub_…

df09039

…backend_handler.py to avoid failing tests

Madjid-CH requested a review from vedpatwardhan September 13, 2023 11:14

inlined variable in available_sub_backend_implementations function

29ac2aa

vedpatwardhan suggested changes Sep 14, 2023

View reviewed changes

removed _check_callable helper since it's not needed anymore after pa…

a84a466

…ssing fn_name directly

Madjid-CH requested a review from vedpatwardhan September 14, 2023 10:23

vedpatwardhan suggested changes Sep 15, 2023

View reviewed changes

ivy/utils/backend/sub_backend_handler.py Outdated Show resolved Hide resolved

Madjid-CH requested a review from vedpatwardhan September 15, 2023 09:33

ivy-seed assigned KevinUli and unassigned D0m-inic Sep 17, 2023

vedpatwardhan suggested changes Sep 18, 2023

View reviewed changes

ivy/utils/backend/handler.py Show resolved Hide resolved

ivy/utils/backend/sub_backend_handler.py Outdated Show resolved Hide resolved

Madjid Chergui added 2 commits September 18, 2023 12:30

renamed _set_backend_as_ivy to _set_module_backend

f3ba4a0

Merge remote-tracking branch 'upstream/main' into sub-backend-impleme…

153eb85

…ntation # Conflicts: # ivy/utils/backend/sub_backend_handler.py

vedpatwardhan suggested changes Sep 19, 2023

View reviewed changes

ivy/utils/backend/sub_backend_handler.py Outdated Show resolved Hide resolved

ivy/utils/backend/handler.py Show resolved Hide resolved

Madjid Chergui added 3 commits September 19, 2023 09:53

simplified finding available sub backends implementations by removing…

dca8bc4

… _find_available_sub_backends_dict

moved backend tests to a new folder

e47e9ba

updated tests to skip xformers is not installed

c1954f0

Madjid-CH requested a review from vedpatwardhan September 19, 2023 10:43

vedpatwardhan suggested changes Sep 20, 2023

View reviewed changes

ivy/utils/backend/sub_backend_handler.py Outdated Show resolved Hide resolved

Madjid Chergui added 2 commits September 20, 2023 19:01

removed '_for' from 'available_sub_backend_implementations_for' funct…

aa729b0

…ion.

Merging

724f5e9

Madjid-CH requested a review from vedpatwardhan September 20, 2023 18:31

Madjid Chergui added 2 commits September 20, 2023 19:38

restructured sub_backend_handler.py

265a472

fixed failing test_set_backend with paddle backend

98e44a6

vedpatwardhan approved these changes Sep 21, 2023

View reviewed changes

Madjid-CH merged commit dd7dc3b into ivy-llc:main Sep 21, 2023
75 of 135 checks passed

Madjid-CH deleted the sub-backend-implementation branch September 21, 2023 09:02

vedpatwardhan mentioned this pull request Sep 25, 2023

feat: setting sub_backends by default if they are available #25976

Merged

iababio pushed a commit to iababio/ivy that referenced this pull request Sep 27, 2023

feat(backend handler): throwing a warning when a sub-backend implemen…

5816ab8

…tation is available but is not being used. (ivy-llc#23489)

druvdub pushed a commit to druvdub/ivy that referenced this pull request Oct 14, 2023

feat(backend handler): throwing a warning when a sub-backend implemen…

fddd19d

…tation is available but is not being used. (ivy-llc#23489)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: throwing a warning when a sub-backend implementation is available but is not being used. #23489

feat: throwing a warning when a sub-backend implementation is available but is not being used. #23489

Madjid-CH commented Sep 12, 2023

github-actions bot commented Sep 12, 2023

vedpatwardhan left a comment

github-actions bot left a comment •

edited

Loading

vedpatwardhan left a comment

vedpatwardhan left a comment

vedpatwardhan left a comment

vedpatwardhan left a comment

vedpatwardhan left a comment

feat: throwing a warning when a sub-backend implementation is available but is not being used. #23489

feat: throwing a warning when a sub-backend implementation is available but is not being used. #23489

Conversation

Madjid-CH commented Sep 12, 2023

PR Description

github-actions bot commented Sep 12, 2023

vedpatwardhan left a comment

Choose a reason for hiding this comment

github-actions bot left a comment • edited Loading

Choose a reason for hiding this comment

PR Compliance Checks

Issue Reference

vedpatwardhan left a comment

Choose a reason for hiding this comment

vedpatwardhan left a comment

Choose a reason for hiding this comment

vedpatwardhan left a comment

Choose a reason for hiding this comment

vedpatwardhan left a comment

Choose a reason for hiding this comment

vedpatwardhan left a comment

Choose a reason for hiding this comment

github-actions bot left a comment •

edited

Loading