Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Commit

Permalink
add doc to explain call structure and how to override
Browse files Browse the repository at this point in the history
  • Loading branch information
szha committed Oct 31, 2019
1 parent de0dcf6 commit 9abf451
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion python/mxnet/gluon/contrib/estimator/estimator.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,11 @@ def evaluate(self,
val_data,
val_metrics,
batch_axis=0):
"""Evaluate model on validation data
"""Evaluate model on validation data.
This function calls :py:func:`evaluate_batch` on each of the batches from the
validation data loader. Thus, for custom use cases, it's possible to inherit the
estimator class and override :py:func:`evaluate_batch`.
Parameters
----------
Expand Down Expand Up @@ -284,6 +288,10 @@ def fit(self, train_data,
number of epochs or batches. The batch size is inferred from the
data loader's batch_size.
This function calls :py:func:`fit_batch` on each of the batches from the
training data loader. Thus, for custom use cases, it's possible to inherit the
estimator class and override :py:func:`fit_batch`.
Parameters
----------
train_data : DataLoader
Expand Down

0 comments on commit 9abf451

Please sign in to comment.