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

Improve language and fix function arity in docs #591

Merged
merged 3 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/axon/compiler.ex
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ defmodule Axon.CompileError do
else
"""

(pass debug: true to build/compile see where the layer was defined)
(pass debug: true to build/compile to see where the layer was defined)

"""
end
Expand Down
12 changes: 6 additions & 6 deletions lib/axon/layers.ex
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ defmodule Axon.Layers do
## Options

* `:strides` - kernel strides. Can be a scalar or a list
who's length matches the number of spatial dimensions in
whose length matches the number of spatial dimensions in
the input tensor. Defaults to 1.

* `:padding` - zero padding on the input. Can be one of
Expand Down Expand Up @@ -393,7 +393,7 @@ defmodule Axon.Layers do
## Options

* `:strides` - kernel strides. Can be a scalar or a list
who's length matches the number of spatial dimensions in
whose length matches the number of spatial dimensions in
the input tensor. Defaults to 1.

* `:padding` - zero padding on the input. Can be one of
Expand Down Expand Up @@ -516,7 +516,7 @@ defmodule Axon.Layers do
## Options

* `:strides` - kernel strides. Can be a scalar or a list
who's length matches the number of spatial dimensions in
whose length matches the number of spatial dimensions in
the input tensor. Defaults to 1.

* `:padding` - zero padding on the input. Can be one of
Expand Down Expand Up @@ -608,7 +608,7 @@ defmodule Axon.Layers do
## Options

* `:strides` - kernel strides. Can be a scalar or a list
who's length matches the number of spatial dimensions in
whose length matches the number of spatial dimensions in
the input tensor. Defaults to 1.

* `:padding` - zero padding on the input. Can be one of
Expand Down Expand Up @@ -675,7 +675,7 @@ defmodule Axon.Layers do
## Options

* `:strides` - kernel strides. Can be a scalar or a list
who's length matches the number of spatial dimensions in
whose length matches the number of spatial dimensions in
the input tensor. Defaults to 1.

* `:padding` - zero padding on the input. Can be one of
Expand Down Expand Up @@ -735,7 +735,7 @@ defmodule Axon.Layers do
of the input tensor. Required.

* `:strides` - kernel strides. Can be a scalar or a list
who's length matches the number of spatial dimensions in
whose length matches the number of spatial dimensions in
the input tensor. Defaults to size of kernel.

* `:padding` - zero padding on the input. Can be one of
Expand Down
2 changes: 1 addition & 1 deletion lib/axon/loop.ex
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ defmodule Axon.Loop do
defp raise_bad_training_inputs!(data, state) do
raise ArgumentError,
"invalid arguments given to train-step initialization," <>
" this usually happens when you pass a invalid parameters" <>
" this usually happens when you pass invalid parameters" <>
" to Axon.Loop.run with a loop constructed using Axon.Loop.trainer" <>
" or Axon.Loop.evaluator, supervised training and evaluation loops" <>
" expect a stream or enumerable of inputs" <>
Expand Down
4 changes: 2 additions & 2 deletions lib/axon/quantization.ex
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ defmodule Axon.Quantization do
The only supported conversion is to convert regular dense layers
to a weight-only 8-bit integer variant. Note that this only replaces
the properties of the model. If you have a pre-trained model state
that you wish to quantize, refer to `Axon.Quantization.quantize_model_state/1`.
that you wish to quantize, refer to `Axon.Quantization.quantize_model_state/2`.

All `:dense` layers in the model are replaced with `Axon.Quantization.weight_only_quantized_dense/3`.
"""
Expand Down Expand Up @@ -89,7 +89,7 @@ defmodule Axon.Quantization do
This is equivalent to a dense layer, but works on quantized
weights for reducing model memory footprint.

Compiles to `Axon.Quantization.Layers.weight_only_quantized_dense/4`.
Compiles to `Axon.Quantization.Layers.weight_only_quantized_dense/3`.

## Options

Expand Down
Loading