-
Notifications
You must be signed in to change notification settings - Fork 201
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
feat: add better errors for invalid compiler configurations #1575
Merged
polvalente
merged 3 commits into
main
from
pv-docs/improve-errors-for-missing-callbacks
Jan 30, 2025
+81
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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 file contains 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 file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
defmodule Nx.Defn.CompilerTest do | ||
use ExUnit.Case, async: true | ||
|
||
defmodule SomeInvalidServing do | ||
def init(_, _, _) do | ||
:ok | ||
end | ||
end | ||
|
||
test "raises an error if the __compile__ callback is missing" do | ||
msg = | ||
"the expected compiler callback __compile__/4 is missing. Please check that the module SomeInvalidCompiler is an Nx.Defn.Compiler." | ||
|
||
assert_raise ArgumentError, msg, fn -> | ||
Nx.Defn.compile(&Function.identity/1, [Nx.template({}, :f32)], | ||
compiler: SomeInvalidCompiler | ||
) | ||
end | ||
end | ||
|
||
test "raises an error if the __jit__ callback is missing" do | ||
msg = | ||
"the expected compiler callback __jit__/5 is missing. Please check that the module SomeInvalidCompiler is an Nx.Defn.Compiler." | ||
|
||
assert_raise ArgumentError, msg, fn -> | ||
Nx.Defn.jit(&Function.identity/1, compiler: SomeInvalidCompiler).(1) | ||
end | ||
end | ||
|
||
test "raises an error if the __partitions_options__ callback is missing" do | ||
msg = | ||
"the expected compiler callback __partitions_options__/1 is missing. Please check that the module SomeInvalidCompiler is an Nx.Defn.Compiler." | ||
|
||
serving = Nx.Serving.new(SomeInvalidServing, [], compiler: SomeInvalidCompiler) | ||
|
||
assert_raise ArgumentError, msg, fn -> | ||
Nx.Serving.init({MyName, serving, true, [1], 10, 1000, nil, 1}) | ||
end | ||
end | ||
|
||
test "raises an error if the __to_backend__ callback is missing" do | ||
msg = | ||
"the expected compiler callback __to_backend__/1 is missing. Please check that the module SomeInvalidCompiler is an Nx.Defn.Compiler." | ||
|
||
assert_raise ArgumentError, msg, fn -> | ||
Nx.Defn.to_backend(compiler: SomeInvalidCompiler) | ||
end | ||
end | ||
end |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@josevalim I used ArgumentError because this is directly caused by an invalid option being passed. If you have another suggestion for the exception type, I'm open to it!