crandas.crlearn
***************

The module ``crandas.crlearn`` provides the following functionality:

Machine learing models:

- :ref:`crlearn_linreg`
- :ref:`crlearn_logreg`
- :ref:`crlearn_rf`
- :ref:`crlearn_knn`

General:

- :ref:`crlearn_model`
- :ref:`crlearn_metrics`
- :ref:`crlearn_utility`
- :ref:`crlearn_optimizer`

.. _crlearn_model:

Model interface
---------------

.. automodule:: crandas.crlearn.model
   :members:
   :show-inheritance:

.. _crlearn_metrics:

Metrics
-------

.. automodule:: crandas.crlearn.metrics
   :members:
   :show-inheritance:


.. _crlearn_utility:

Utility functions
-----------------

.. automodule:: crandas.crlearn.utils
   :members:
   :show-inheritance:

.. _crlearn_linreg:

Linear regression
-----------------

.. automodule:: crandas.crlearn.linear_model
   :members:
   :show-inheritance:

.. _crlearn_logreg:

Logistic regression
-------------------

.. automodule:: crandas.crlearn.logistic_regression
   :members:
   :show-inheritance:

.. _crlearn_rf:

Random forest classifier
------------------------

.. automodule:: crandas.crlearn.ensemble
   :members:
   :show-inheritance:

.. _crlearn_knn:

k-nearest neighbours regressor
-------------------------------

.. automodule:: crandas.crlearn.neighbors
   :members:
   :show-inheritance:

.. _crlearn_optimizer:

Optimizer settings
------------------

Settings of optimizers used e.g. in logistic regression models. Whenever a value for a parameter
is not given, the engine uses a default value if one is available.

.. automodule:: crandas.crlearn.optimizer
   :members:
   :show-inheritance:

.. to add a new module you need to reference the python file instead of the folder (see VDL client)