Usage
=====

.. _Usage::

BFS can be loaded in a python script as any other module using the ``import`` command.
BFS is based on the Keras module and works similarly. 

To launch BFS in a python script, use with the following commands:
::

    from BGFS.BFS import BFS

    model = BFS(n_attr, pref_vector1, pref_vector2, n_hidden, n_output)
    model.compile(init_optimizer, train_optimizer, init_learning_rate, 
                    train_learning_rate, metrics)
    model.fit(X_train, y_train, validation_data=(X_val, y_val))


`pref_vector1` and `pref_vector2` are the two vectors delimiting the regions and can be obtained with
the `circle_points` function in ``utils.py``. 

``utils.py`` also contains extra functions that can be used to analyze the obtained results.