Skip to content

Commit

Permalink
Document compile options are the same as build
Browse files Browse the repository at this point in the history
  • Loading branch information
josevalim committed Feb 23, 2023
1 parent 42698b1 commit 07765ed
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions lib/axon.ex
Original file line number Diff line number Diff line change
Expand Up @@ -3513,6 +3513,10 @@ defmodule Axon do
This function makes use of the built-in `Nx.Defn.compile/3`. Note
that passing inputs which differ in shape or type from the templates
provided to this function will result in a crash.
## Options
It accepts the same options as `build/2`.
"""
@doc type: :model
def compile(model, template, init_params \\ %{}, opts \\ []) when is_list(opts) do
Expand Down

0 comments on commit 07765ed

Please sign in to comment.