#110 added documentation and added referenced to keras and tf branches

Author: maxsch3

keras_batchflow/base/batch_generators/batch_generator.py

@@ -35,6 +35,12 @@ class BatchGenerator:
     - **shuffle** - (optional) *bool*, if true, the input dataframe is shuffled before each new epoch.
         **Default: False**
     - **train_mode** - (optional) *bool*. If true, both X and Y are returned, otherwise only X is returned
+    - **encoder_adapter** - (optional) *str* or a single instance of a class derived from
+        keras_batchflow.base.batch_shapers.IEncoderAdaptor class. String values supported: 'numpy' and 'pandas'. If
+        not provided, 'numpy' is used. This parameter sets format that encoders are using. Sklearn encoders are
+        created for numpy arrays hence the default value is numpy. If your encoders require pandas format, use
+        'pandas'. Alternatively, if your encoders need some special format, create your instance derived from
+        IEncoderAdaptor class
     """
 
     def __init__(self, data: pd.DataFrame, x_structure, y_structure=None,

keras_batchflow/base/batch_shapers/__init__.py

@@ -1 +1,4 @@
 from .batch_shaper import BatchShaper
+from .encoder_adaptor import IEncoderAdaptor
+from .numpy_encoder_adaptor import NumpyEncoderAdaptor
+from .pandas_encoder_adaptor import PandasEncoderAdaptor

keras_batchflow/keras/batch_shapers/__init__.py

@@ -1 +1,4 @@
-from keras_batchflow.base.batch_shapers import BatchShaper
+from keras_batchflow.base.batch_shapers import BatchShaper
+from keras_batchflow.base.batch_shapers import IEncoderAdaptor
+from keras_batchflow.base.batch_shapers import NumpyEncoderAdaptor
+from keras_batchflow.base.batch_shapers import PandasEncoderAdaptor

keras_batchflow/tf/batch_shapers/__init__.py

@@ -1 +1,4 @@
-from keras_batchflow.base.batch_shapers import BatchShaper
+from keras_batchflow.base.batch_shapers import BatchShaper
+from keras_batchflow.base.batch_shapers import IEncoderAdaptor
+from keras_batchflow.base.batch_shapers import NumpyEncoderAdaptor
+from keras_batchflow.base.batch_shapers import PandasEncoderAdaptor