Skip to content

Commit

Permalink
doc: add note on KerasRegressor.score() return value to migration gui…
Browse files Browse the repository at this point in the history
…de (#255)
  • Loading branch information
adriangb authored Nov 29, 2021
1 parent 85aab43 commit 57918d6
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/source/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ Calling ``fit`` resets this attribute, calling ``partial_fit`` on the other hand
.. note::
Unlike the TensorFlow wrappers, SciKeras normalizes the names of the keys, so that if you use `metrics=["mae"]` you will get a key named `"mean_absolute_error"`.

``score()`` return R^2 by default for regressors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Keras returns your model's mean loss when ``KerasRegressor.score()`` is called.
SciKeras, like most Scikit-Learn estimators, returns the coefficient of determination of the prediction (also known as R^2 score).
This is however customizable.

One-hot encoding of targets for categorical crossentropy losses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Expand Down

0 comments on commit 57918d6

Please sign in to comment.