Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Python libsvm 3.33 crashes due to unexpected argument to jit #218

Open
nilfm99 opened this issue Aug 7, 2024 · 9 comments
Open

Python libsvm 3.33 crashes due to unexpected argument to jit #218

nilfm99 opened this issue Aug 7, 2024 · 9 comments

Comments

@nilfm99
Copy link
Contributor

nilfm99 commented Aug 7, 2024

See this build: https://github.com/Netflix/vmaf/actions/runs/10284246506/job/28459862846

Sample test failure:

____________________ ERROR collecting test/doctest_test.py _____________________
test/doctest_test.py:12: in <module>
    from vmaf.core import quality_runner
vmaf/core/quality_runner.py:9: in <module>
    from libsvm import svmutil
.tox/py311/lib/python3.11/site-packages/libsvm/svmutil.py:2: in <module>
    from .svm import *
.tox/py311/lib/python3.11/site-packages/libsvm/svm.py:144: in <module>
    @jit(nopython=True)
E   TypeError: <lambda>() got an unexpected keyword argument 'nopython'

The previous tag, 3.32, does not have this problem. It seems this commit is responsible. One solution could be to modify the "fallback" definition of jit here to take *args and **kwargs and do nothing with them.

@advilbn
Copy link

advilbn commented Aug 8, 2024

You could also yank the current version 3.33.0 in pypi, that way no one would need to pin/exclude manually this version.

@nilfm99 , in your PR (#219), you could use a version of the decorator using, functools.wrapps

try:
    from numba import jit
    jit_enabled = True
except:
    from functools import wraps as functools_wraps
 
    def jit(_func=None, *args, **kwargs):
        def decorator_jit(func):
            @functools_wraps(func)
            def wrapper_jit(*args, **kwargs):
                return func(*args, **kwargs)
            return wrapper_jit

        return decorator_jit if _func is None else decorator_jit(_func)
 
    jit_enabled = False

@nilfm99
Copy link
Contributor Author

nilfm99 commented Aug 8, 2024

@advilbn I am not a maintainer of this project, but I agree it should be yanked. As it stands, just importing the python code without numba installed breaks.

Regarding the suggested code, I agree it looks better this way and will update it.

@cjlin1
Copy link
Owner

cjlin1 commented Aug 8, 2024 via email

@advilbn
Copy link

advilbn commented Aug 8, 2024

@cjlin1 , Could you also yanked the version 3.33.0 ? As i mentioned before this prevents users or automatic cicd pipelines to fail installing this version. Yanking gives time to not rush patching but providing a good user event/issue experience.

NoteL You could yank the package in the pypi website using you account.

Thank in advances, for all you help on this.

@Sinacam
Copy link
Contributor

Sinacam commented Aug 9, 2024

@advilbn Version 3.33.0 has been yanked from PyPI, thanks for the reminder.

@Sinacam
Copy link
Contributor

Sinacam commented Aug 9, 2024

@nilfm99 We are in the process of releasing 3.33.1, and we opted to use the original commit 8802a10 in your PR. functools.wraps seems to be more complicated than necessary for our purpose because jit is never going to be anything other than identity, which doesn't have issues with function attributes. Are there other concerns I missed?

@advilbn
Copy link

advilbn commented Aug 9, 2024

@Sinacam , please check functools.wraps documentations, https://docs.python.org/3/library/functools.html#functools.wraps. Using it is more a technicality to avoid loosing the name and docstrings when using decorators. the documentation has an example, that illustrates it.

@Sinacam
Copy link
Contributor

Sinacam commented Aug 9, 2024

@advilbn Yes, I am aware functools.wraps forwards function attributes such as name and docstrings. As mentioned, jit being the identity doesn't suffer from those problems, there isn't a wrapper to begin with. For example

def jit(func=None, *args, **kwargs):
    if func is None:
        return lambda x: x
    else:
        return func

@jit
def f():
    """docstring f"""

@jit(nopython=True)
def g():
    """docstring g"""

print(f.__name__) # f
print(f.__doc__) # docstring f
print(g.__name__) # g
print(g.__doc__) # docstring g

If there are no other concerns, we will proceed as planned.

@advilbn
Copy link

advilbn commented Aug 9, 2024

@Sinacam , thanks for the explanation and your help on this. No concerns from my end.

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

No branches or pull requests

4 participants