update the version number
[ti-machine-learning/ti-machine-learning.git] / src / common / cnn / timlCNNCostWithLabel.c
1 /******************************************************************************/
2 /*!
3  * \file timlCNNCostWithLabel.c
4  */
5 /* Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com/
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  *    Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
14  *    Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the
17  *    distribution.
18  *
19  *    Neither the name of Texas Instruments Incorporated nor the names of
20  *    its contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34  *
35  ******************************************************************************/
38 /*******************************************************************************
39  *
40  * INCLUDES
41  *
42  ******************************************************************************/
44 #include "../api/timl.h"
47 /******************************************************************************/
48 /*!
49  * \ingroup       cnn
50  * \brief         Calculate the cost based on the cnn output and the label
51  * \param[in]     cnn          CNN
52  * \param[in]     label        Label
53  * \param[in,out] cost         Cost
54  * \param[in,out] bpStartLayer Back propagation start layer
55  * \return        Error code
56  */
57 /******************************************************************************/
59 int timlCNNCostWithLabel(timlConvNeuralNetwork *cnn, int label, float *cost, timlCNNLayer **bpStartLayer)
60 {
61    int          err;
62    timlCNNLayer *layer;
63    int          dim;
64    int          deviceId;
65    int          threadId;
67    // init
68    err      = 0;
69    layer    = cnn->tail;
70    dim      = layer->channel;
71    deviceId = cnn->deviceId;
72    threadId = cnn->threadId;
74    switch (cnn->params.costType) {
75       case Util_MSE:
76          *cost = 0.5*timlUtilMeanSqaureError(layer->featureMap, label, dim);
77          break;
78       case Util_CrossEntropy:
79          *cost = timlUtilMultinomialCrossEntropy(layer->featureMap, label, dim);
80          if (layer->type == CNN_Nonlinear && (layer->nonlinearParams.type == Util_Softmax || layer->nonlinearParams.type == Util_Sigmoid)) {
81             layer = layer->prev; // move ahead one layer
82             *bpStartLayer = layer;
83          }
84          timlUtilBLASscopy(dim, layer->next->featureMap, layer->delta, deviceId, threadId);
85          // delta + label -= 1.0
86          timlUtilSubtract(layer->delta + label, 1.0, deviceId, threadId);
87          break;
88    }
90    return err;
91 }