C++ API Reference for Intel® Data Analytics Acceleration Library 2020 Update 1

neural_networks_learnable_parameters.h
1 /* file: neural_networks_learnable_parameters.h */
2 /*******************************************************************************
3 * Copyright 2014-2020 Intel Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *******************************************************************************/
17 
18 /*
19 //++
20 // Implementation of neural network model.
21 //--
22 */
23 
24 #ifndef __NEURAL_NETWORKS_LEARNABLE_PARAMETERS_H__
25 #define __NEURAL_NETWORKS_LEARNABLE_PARAMETERS_H__
26 
27 #include "algorithms/algorithm.h"
28 #include "algorithms/neural_networks/neural_networks_types.h"
29 
30 #include "data_management/data/homogen_numeric_table.h"
31 #include "data_management/data/homogen_tensor.h"
32 
33 namespace daal
34 {
35 namespace algorithms
36 {
37 namespace neural_networks
38 {
39 namespace interface1
40 {
50 class LearnableParametersIface : public data_management::SerializationIface
51 {
52 public:
53  /*
54  * \DAAL_DEPRECATED
55  */
56  virtual ~LearnableParametersIface() {}
57 
58  /*
59  * \DAAL_DEPRECATED
60  */
61  virtual data_management::NumericTablePtr copyToTable() const = 0;
62  /*
63  * \DAAL_DEPRECATED
64  */
65  DAAL_DEPRECATED_VIRTUAL virtual data_management::NumericTablePtr copyToTable(size_t idx) const = 0;
66  /*
67  * \DAAL_DEPRECATED
68  */
69  virtual services::Status copyFromTable(const data_management::NumericTablePtr &table) = 0;
70  /*
71  * \DAAL_DEPRECATED
72  */
73  DAAL_DEPRECATED_VIRTUAL virtual services::Status copyFromTable(const data_management::NumericTablePtr &table, size_t idx) = 0;
74  /*
75  * \DAAL_DEPRECATED
76  */
77 };
78 typedef services::SharedPtr<LearnableParametersIface> LearnableParametersIfacePtr;
79 
85 class DAAL_EXPORT ModelImpl : public daal::algorithms::Model
86 {
87 public:
88  /*
89  * \DAAL_DEPRECATED
90  */
91  virtual ~ModelImpl() {}
92 
98  DAAL_DEPRECATED const services::SharedPtr<services::Collection<layers::NextLayers> > getNextLayers() const
99  {
100  return _nextLayers;
101  }
102 
110  services::Status setWeightsAndBiases(const data_management::NumericTablePtr &weightsAndBiases)
111  {
112  return _weightsAndBiases->copyFromTable(weightsAndBiases);
113  }
114 
120  const data_management::NumericTablePtr getWeightsAndBiases() const
121  {
122  return _weightsAndBiases->copyToTable();
123  }
124 
125 protected:
126  /*
127  * \DAAL_DEPRECATED
128  */
129  DAAL_DEPRECATED ModelImpl() :
130  _forwardLayers(new neural_networks::ForwardLayers),
131  _nextLayers(new services::Collection<layers::NextLayers>),
132  _weightsAndBiasesCreated(false), _storeWeightsInTable(false)
133  {}
134 
135  /*
136  * \DAAL_DEPRECATED
137  */
138  DAAL_DEPRECATED ModelImpl(services::Status &st) :
139  _weightsAndBiasesCreated(false), _storeWeightsInTable(false)
140  {
141  _forwardLayers.reset(new neural_networks::ForwardLayers);
142  if (!_forwardLayers)
143  st.add(services::ErrorMemoryAllocationFailed);
144  _nextLayers.reset(new services::Collection<layers::NextLayers>);
145  if (!_nextLayers)
146  st.add(services::ErrorMemoryAllocationFailed);
147  }
148 
157  DAAL_DEPRECATED ModelImpl(const neural_networks::ForwardLayersPtr &forwardLayers,
158  const services::SharedPtr<services::Collection<layers::NextLayers> > &nextLayers,
159  bool storeWeightsInTable = false) :
160  _forwardLayers(forwardLayers), _nextLayers(nextLayers),
161  _weightsAndBiasesCreated(false), _storeWeightsInTable(storeWeightsInTable) {}
162 
163  /*
164  * \DAAL_DEPRECATED
165  */
166  DAAL_DEPRECATED ModelImpl(const neural_networks::ForwardLayersPtr &forwardLayers,
167  const services::SharedPtr<services::Collection<layers::NextLayers> > &nextLayers,
168  bool storeWeightsInTable, services::Status &st) :
169  _forwardLayers(forwardLayers), _nextLayers(nextLayers),
170  _weightsAndBiasesCreated(false), _storeWeightsInTable(storeWeightsInTable) {}
171 
172  /*
173  * \DAAL_DEPRECATED
174  */
175  ModelImpl(const ModelImpl &model) :
176  _forwardLayers(model._forwardLayers), _nextLayers(model._nextLayers),
177  _storeWeightsInTable(model._storeWeightsInTable),
178  _weightsAndBiasesCreated(model._weightsAndBiasesCreated)/*,
179  _weightsAndBiases(model._weightsAndBiases->clone()) */ {}
180 
181  /*
182  * Copy constructor
183  * \DAAL_DEPRECATED
184  */
185  DAAL_DEPRECATED ModelImpl(const ModelImpl &model, services::Status &st) :
186  _forwardLayers(model._forwardLayers), _nextLayers(model._nextLayers),
187  _storeWeightsInTable(model._storeWeightsInTable),
188  _weightsAndBiasesCreated(model._weightsAndBiasesCreated)/*,
189  _weightsAndBiases(model._weightsAndBiases->clone()) */ {}
190 
191  /*
192  * \DAAL_DEPRECATED
193  */
194  DAAL_DEPRECATED services::Status checkWeightsAndBiasesAllocation()
195  {
196  using namespace services;
197  using namespace layers;
198 
199  _storeWeightsInTable = true;
200  size_t nLayers = _forwardLayers->size();
201  for (size_t i = 0; i < nLayers; i++)
202  {
203  forward::Input *forwardInput = _forwardLayers->get(i)->getLayerInput();
204  /* Check if weights and biases are allocated by user */
205  if (forwardInput->get(forward::weights) || forwardInput->get(forward::biases))
206  {
207  _storeWeightsInTable = false;
208  break;
209  }
210  }
211  return services::Status();
212  }
213 
214  /*
215  * \DAAL_DEPRECATED
216  */
217  services::Status connectForwardLayers(size_t layerId)
218  {
219  using namespace services;
220  using namespace layers;
221 
222  forward::LayerIfacePtr forwardLayer = _forwardLayers->get(layerId);
223  forwardLayer->allocateResult();
224  forward::ResultPtr forwardResult = forwardLayer->getLayerResult();
225  const NextLayers &next = _nextLayers->get(layerId);
226  for(size_t j = 0; j < next.size(); j++)
227  {
228  _forwardLayers->get(next[j])->addInput(forwardResult, j, 0 /* index in input object of next[j] forward layer */);
229  }
230  return services::Status();
231  }
232 
233  /*
234  * \DAAL_DEPRECATED
235  */
236  template<typename modelFPType>
237  DAAL_EXPORT services::Status createWeightsAndBiases(bool checkAllocation);
238 
239  bool _weightsAndBiasesCreated;
240  bool _storeWeightsInTable;
242  neural_networks::ForwardLayersPtr _forwardLayers;
243  services::SharedPtr<services::Collection<layers::NextLayers> > _nextLayers;
244  LearnableParametersIfacePtr _weightsAndBiases;
245 };
247 }
248 using interface1::ModelImpl;
249 using interface1::LearnableParametersIface;
250 using interface1::LearnableParametersIfacePtr;
251 }
252 }
253 }
254 #endif
daal::algorithms::neural_networks::interface1::ModelImpl::_nextLayers
services::SharedPtr< services::Collection< layers::NextLayers > > _nextLayers
Definition: neural_networks_learnable_parameters.h:243
daal::algorithms::neural_networks::interface1::ModelImpl::_storeWeightsInTable
bool _storeWeightsInTable
Definition: neural_networks_learnable_parameters.h:240
daal::algorithms::neural_networks::interface1::ForwardLayers
services::Collection< layers::forward::LayerIfacePtr > ForwardLayers
Represents a collection of forward stages of neural network layers.
Definition: neural_networks_types.h:59
daal::algorithms::neural_networks::interface1::ModelImpl::setWeightsAndBiases
services::Status setWeightsAndBiases(const data_management::NumericTablePtr &weightsAndBiases)
Definition: neural_networks_learnable_parameters.h:110
daal::algorithms::neural_networks::interface1::LearnableParametersIface
Learnable parameters for the prediction stage of neural network algorithm.
Definition: neural_networks_learnable_parameters.h:50
daal::algorithms::neural_networks::interface1::ModelImpl
Class Model object for the prediction stage of neural network algorithm.
Definition: neural_networks_learnable_parameters.h:85
daal::algorithms::neural_networks::interface1::ModelImpl::_forwardLayers
neural_networks::ForwardLayersPtr _forwardLayers
Definition: neural_networks_learnable_parameters.h:242
daal::algorithms::elastic_net::training::model
Definition: elastic_net_training_types.h:109
daal::algorithms::elastic_net::training::weights
Definition: elastic_net_training_types.h:89
daal::services::ErrorMemoryAllocationFailed
Definition: error_indexes.h:150
daal::algorithms::neural_networks::interface1::ModelImpl::getWeightsAndBiases
const data_management::NumericTablePtr getWeightsAndBiases() const
Definition: neural_networks_learnable_parameters.h:120
daal::algorithms::neural_networks::interface1::ModelImpl::ModelImpl
DAAL_DEPRECATED ModelImpl(const neural_networks::ForwardLayersPtr &forwardLayers, const services::SharedPtr< services::Collection< layers::NextLayers > > &nextLayers, bool storeWeightsInTable=false)
Definition: neural_networks_learnable_parameters.h:157
daal::algorithms::neural_networks::interface1::ModelImpl::getNextLayers
DAAL_DEPRECATED const services::SharedPtr< services::Collection< layers::NextLayers > > getNextLayers() const
Definition: neural_networks_learnable_parameters.h:98

For more complete information about compiler optimizations, see our Optimization Notice.