Skip to content

Commit

Permalink
Mention that a numpy array must be passed to doc arg
Browse files Browse the repository at this point in the history
  • Loading branch information
teabolt committed Jul 11, 2019
1 parent bcaf7ca commit 9d2d22a
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/source/libraries/keras.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Important arguments to :func:`eli5.explain_prediction` for ``Model`` and ``Seque

* ``doc`` is an image as a tensor that can be inputted to the model.

- The type is a ``numpy.ndarray``.
- The tensor must be an instance of ``numpy.ndarray``.

- Usually the tensor has the format `(batch, dims, ..., channels)` (channels last format, `dims=(height, width)`, `batch=1`, one image), i.e. `BHWC`.

Expand Down
2 changes: 1 addition & 1 deletion eli5/keras/explain_prediction.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def explain_prediction_keras(estimator, # type: Model
An input image as a tensor to ``estimator``,
from which prediction will be done and explained.
For example a ``numpy.ndarray``.
Currently only numpy arrays are supported.
The tensor must be of suitable shape for the ``estimator``.
Expand Down

0 comments on commit 9d2d22a

Please sign in to comment.