doc: document that TensorFlow Datasets are not supported as inputs (#266

)
adriangb · Feb 15, 2022 · 1060d3c · 1060d3c
1 parent cbc7940
commit 1060d3c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/source/migration.rst b/docs/source/migration.rst
@@ -146,3 +146,10 @@ tunable parameters (i.e. settable via ``set_params``):
 
 That said, if you do not need them to work with ``set_params`` (which is only really
 necessary if you are doing hyperparameter tuning), you do not need to make any changes.
+
+Only Scikit-Learn compatible inputs are supported
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to be compatible with all of the features of Scikit-Learn, SciKeras has to make some assumptions about the inputs.
+The main implication of this is that **TensorFlow Dataset inputs are not supported**.
+Instead, you will have to convert your inputs to a numpy array, Pandas dataframe or lists before passing them into SciKeras (or a Scikit-Learn pipeline/hyperparameter tuner wrapping it).
diff --git a/pyproject.toml b/pyproject.toml
@@ -26,7 +26,7 @@ license = "MIT"
 name = "scikeras"
 readme = "README.md"
 repository = "https://github.com/adriangb/scikeras"
-version = "0.6.0"
+version = "0.6.1"
 
 [tool.poetry.dependencies]
 importlib-metadata = {version = "^3", python = "<3.8"}