.. _f-neuraltreeapi: module ``ml._neural_tree_api`` ============================== .. inheritance-diagram:: mlstatpy.ml._neural_tree_api Short summary +++++++++++++ module ``mlstatpy.ml._neural_tree_api`` Conversion from tree to neural network. :githublink:`%|py|6` Classes +++++++ +-------------------------------------------------------------------+--------------------------------------------------+ | class | truncated documentation | +===================================================================+==================================================+ | :class:`_TrainingAPI ` | Declaration of function needed to train a model. | +-------------------------------------------------------------------+--------------------------------------------------+ Properties ++++++++++ +---------------------------------------------------------------------------------------+-------------------------+ | property | truncated documentation | +=======================================================================================+=========================+ | :meth:`training_weights ` | Returns the weights. | +---------------------------------------------------------------------------------------+-------------------------+ Methods +++++++ +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | method | truncated documentation | +=====================================================================================================+==============================================================+ | :meth:`dlossds ` | Computes the loss derivative due to prediction error. | +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | :meth:`fill_cache ` | Creates a cache with intermediate results. | +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | :meth:`fit ` | Fits a neuron. | +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | :meth:`gradient ` | Computes the gradient in *X* knowing the expected value *y*. | +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | :meth:`gradient_backward ` | Computes the gradient in X. | +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | :meth:`loss ` | Computes the loss. Returns a float. | +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ | :meth:`update_training_weights ` | Updates weights. | +-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: mlstatpy.ml._neural_tree_api :members: :special-members: __init__ :show-inheritance: