Skip to content

Commit f90e5ac

Browse files
authored
Improve language and fix function arity in docs (#591)
* Improve language * Improve language * Fix function arity in docs
1 parent 054eb4c commit f90e5ac

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

lib/axon/compiler.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ defmodule Axon.CompileError do
1717
else
1818
"""
1919
20-
(pass debug: true to build/compile see where the layer was defined)
20+
(pass debug: true to build/compile to see where the layer was defined)
2121
2222
"""
2323
end

lib/axon/layers.ex

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ defmodule Axon.Layers do
222222
## Options
223223
224224
* `:strides` - kernel strides. Can be a scalar or a list
225-
who's length matches the number of spatial dimensions in
225+
whose length matches the number of spatial dimensions in
226226
the input tensor. Defaults to 1.
227227
228228
* `:padding` - zero padding on the input. Can be one of
@@ -393,7 +393,7 @@ defmodule Axon.Layers do
393393
## Options
394394
395395
* `:strides` - kernel strides. Can be a scalar or a list
396-
who's length matches the number of spatial dimensions in
396+
whose length matches the number of spatial dimensions in
397397
the input tensor. Defaults to 1.
398398
399399
* `:padding` - zero padding on the input. Can be one of
@@ -516,7 +516,7 @@ defmodule Axon.Layers do
516516
## Options
517517
518518
* `:strides` - kernel strides. Can be a scalar or a list
519-
who's length matches the number of spatial dimensions in
519+
whose length matches the number of spatial dimensions in
520520
the input tensor. Defaults to 1.
521521
522522
* `:padding` - zero padding on the input. Can be one of
@@ -608,7 +608,7 @@ defmodule Axon.Layers do
608608
## Options
609609
610610
* `:strides` - kernel strides. Can be a scalar or a list
611-
who's length matches the number of spatial dimensions in
611+
whose length matches the number of spatial dimensions in
612612
the input tensor. Defaults to 1.
613613
614614
* `:padding` - zero padding on the input. Can be one of
@@ -675,7 +675,7 @@ defmodule Axon.Layers do
675675
## Options
676676
677677
* `:strides` - kernel strides. Can be a scalar or a list
678-
who's length matches the number of spatial dimensions in
678+
whose length matches the number of spatial dimensions in
679679
the input tensor. Defaults to 1.
680680
681681
* `:padding` - zero padding on the input. Can be one of
@@ -735,7 +735,7 @@ defmodule Axon.Layers do
735735
of the input tensor. Required.
736736
737737
* `:strides` - kernel strides. Can be a scalar or a list
738-
who's length matches the number of spatial dimensions in
738+
whose length matches the number of spatial dimensions in
739739
the input tensor. Defaults to size of kernel.
740740
741741
* `:padding` - zero padding on the input. Can be one of

lib/axon/loop.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ defmodule Axon.Loop do
455455
defp raise_bad_training_inputs!(data, state) do
456456
raise ArgumentError,
457457
"invalid arguments given to train-step initialization," <>
458-
" this usually happens when you pass a invalid parameters" <>
458+
" this usually happens when you pass invalid parameters" <>
459459
" to Axon.Loop.run with a loop constructed using Axon.Loop.trainer" <>
460460
" or Axon.Loop.evaluator, supervised training and evaluation loops" <>
461461
" expect a stream or enumerable of inputs" <>

lib/axon/quantization.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ defmodule Axon.Quantization do
3636
The only supported conversion is to convert regular dense layers
3737
to a weight-only 8-bit integer variant. Note that this only replaces
3838
the properties of the model. If you have a pre-trained model state
39-
that you wish to quantize, refer to `Axon.Quantization.quantize_model_state/1`.
39+
that you wish to quantize, refer to `Axon.Quantization.quantize_model_state/2`.
4040
4141
All `:dense` layers in the model are replaced with `Axon.Quantization.weight_only_quantized_dense/3`.
4242
"""
@@ -92,7 +92,7 @@ defmodule Axon.Quantization do
9292
This is equivalent to a dense layer, but works on quantized
9393
weights for reducing model memory footprint.
9494
95-
Compiles to `Axon.Quantization.Layers.weight_only_quantized_dense/4`.
95+
Compiles to `Axon.Quantization.Layers.weight_only_quantized_dense/3`.
9696
9797
## Options
9898

0 commit comments

Comments
 (0)