Skip to content

Commit 2b1f8ed

Browse files
EthanJYKfchollet
authored andcommitted
Change batch_size descriptions to proper ones (keras-team#13422)
* Change `batch_size` descriptions to proper ones Since there're no gradients updated during `evaulate` and `predict` processes, changed their `batch_size` docstrings from `"Number of samples per gradient update"` to `"Number of samples per evaluation step"` and `"Number of samples to be predicted at once"`. (The sentence in fit remains unchanged.) I hope this fix would change related auto-generated documents as well. * Correct `callbacks` description docstrings Corrected `callbacks` description docstrings in `evaluate_generator` and `predict_generator`: "List of callbacks to apply during training" -> "- during evaluation", "- during prediction".
1 parent 97e3916 commit 2b1f8ed

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

keras/engine/training.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1274,7 +1274,7 @@ def evaluate(self,
12741274
`y` should not be specified (since targets will be obtained
12751275
from `x`).
12761276
batch_size: Integer or `None`.
1277-
Number of samples per gradient update.
1277+
Number of samples per evaluation step.
12781278
If unspecified, `batch_size` will default to 32.
12791279
Do not specify the `batch_size` if your data is in the
12801280
form of symbolic tensors, generators, or
@@ -1383,7 +1383,7 @@ def predict(self, x,
13831383
- None (default) if feeding from framework-native
13841384
tensors (e.g. TensorFlow data tensors).
13851385
batch_size: Integer or `None`.
1386-
Number of samples per gradient update.
1386+
Number of samples to be predicted at once.
13871387
If unspecified, `batch_size` will default to 32.
13881388
Do not specify the `batch_size` if your data is in the
13891389
form of symbolic tensors, generators, or
@@ -1755,7 +1755,7 @@ def evaluate_generator(self, generator,
17551755
Optional for `Sequence`: if unspecified, will use
17561756
the `len(generator)` as a number of steps.
17571757
callbacks: List of `keras.callbacks.Callback` instances.
1758-
List of callbacks to apply during training.
1758+
List of callbacks to apply during evaluation.
17591759
See [callbacks](/callbacks).
17601760
max_queue_size: maximum size for the generator queue
17611761
workers: Integer. Maximum number of processes to spin up
@@ -1813,7 +1813,7 @@ def predict_generator(self, generator,
18131813
Optional for `Sequence`: if unspecified, will use
18141814
the `len(generator)` as a number of steps.
18151815
callbacks: List of `keras.callbacks.Callback` instances.
1816-
List of callbacks to apply during training.
1816+
List of callbacks to apply during prediction.
18171817
See [callbacks](/callbacks).
18181818
max_queue_size: Maximum size for the generator queue.
18191819
workers: Integer. Maximum number of processes to spin up

0 commit comments

Comments
 (0)