C++ API Reference for Intel® Data Analytics Acceleration Library 2018 Update 2

gbt_classification_training_batch.h
1 /* file: gbt_classification_training_batch.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 Intel Corporation
4 * All Rights Reserved.
5 *
6 * If this software was obtained under the Intel Simplified Software License,
7 * the following terms apply:
8 *
9 * The source code, information and material ("Material") contained herein is
10 * owned by Intel Corporation or its suppliers or licensors, and title to such
11 * Material remains with Intel Corporation or its suppliers or licensors. The
12 * Material contains proprietary information of Intel or its suppliers and
13 * licensors. The Material is protected by worldwide copyright laws and treaty
14 * provisions. No part of the Material may be used, copied, reproduced,
15 * modified, published, uploaded, posted, transmitted, distributed or disclosed
16 * in any way without Intel's prior express written permission. No license under
17 * any patent, copyright or other intellectual property rights in the Material
18 * is granted to or conferred upon you, either expressly, by implication,
19 * inducement, estoppel or otherwise. Any license under such intellectual
20 * property rights must be express and approved by Intel in writing.
21 *
22 * Unless otherwise agreed by Intel in writing, you may not remove or alter this
23 * notice or any other notice embedded in Materials by Intel or Intel's
24 * suppliers or licensors in any way.
25 *
26 *
27 * If this software was obtained under the Apache License, Version 2.0 (the
28 * "License"), the following terms apply:
29 *
30 * You may not use this file except in compliance with the License. You may
31 * obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
32 *
33 *
34 * Unless required by applicable law or agreed to in writing, software
35 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
36 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37 *
38 * See the License for the specific language governing permissions and
39 * limitations under the License.
40 *******************************************************************************/
41 
42 /*
43 //++
44 // Implementation of the interface for Gradient Boosted Trees model-based training
45 //--
46 */
47 
48 #ifndef __GBT_CLASSIFICATION_TRAINING_BATCH_H__
49 #define __GBT_CLASSIFICATION_TRAINING_BATCH_H__
50 
51 #include "algorithms/classifier/classifier_training_batch.h"
52 #include "algorithms/gradient_boosted_trees/gbt_classification_training_types.h"
53 
54 namespace daal
55 {
56 namespace algorithms
57 {
58 namespace gbt
59 {
60 namespace classification
61 {
62 namespace training
63 {
64 namespace interface1
65 {
79 template<typename algorithmFPType, Method method, CpuType cpu>
80 class DAAL_EXPORT BatchContainer : public TrainingContainerIface<batch>
81 {
82 public:
88  BatchContainer(daal::services::Environment::env *daalEnv);
90  ~BatchContainer();
95  services::Status compute() DAAL_C11_OVERRIDE;
96  services::Status setupCompute() DAAL_C11_OVERRIDE;
97 };
98 
116 template<typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
117 class DAAL_EXPORT Batch : public classifier::training::Batch
118 {
119 public:
120  typedef classifier::training::Batch super;
121 
122  typedef typename super::InputType InputType;
123  typedef algorithms::gbt::classification::training::Parameter ParameterType;
124  typedef algorithms::gbt::classification::training::Result ResultType;
125 
126  InputType input;
132  Batch(size_t nClasses)
133  {
134  _par = new ParameterType(nClasses);
135  initialize();
136  }
137 
144  Batch(const Batch<algorithmFPType, method> &other) : classifier::training::Batch(other), input(other.input)
145  {
146  _par = new ParameterType(other.parameter());
147  initialize();
148  }
149 
151  ~Batch()
152  {
153  delete _par;
154  }
155 
160  ParameterType& parameter() { return *static_cast<ParameterType*>(_par); }
161 
166  const ParameterType& parameter() const { return *static_cast<const ParameterType*>(_par); }
167 
172  InputType * getInput() DAAL_C11_OVERRIDE { return &input; }
173 
178  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
179 
184  ResultPtr getResult()
185  {
186  return ResultType::cast(_result);
187  }
188 
192  services::Status resetResult() DAAL_C11_OVERRIDE
193  {
194  _result.reset(new ResultType());
195  DAAL_CHECK(_result, services::ErrorNullResult);
196  _res = NULL;
197  return services::Status();
198  }
199 
205  services::SharedPtr<Batch<algorithmFPType, method> > clone() const
206  {
207  return services::SharedPtr<Batch<algorithmFPType, method> >(cloneImpl());
208  }
209 
210  virtual services::Status checkComputeParams() DAAL_C11_OVERRIDE;
211 
212 protected:
213  virtual Batch<algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
214  {
215  return new Batch<algorithmFPType, method>(*this);
216  }
217 
218  services::Status allocateResult() DAAL_C11_OVERRIDE
219  {
220  ResultPtr res = getResult();
221  DAAL_CHECK(res, services::ErrorNullResult);
222  services::Status s = res->template allocate<algorithmFPType>(&input, &parameter(), method);
223  _res = _result.get();
224  return s;
225  }
226 
227  void initialize()
228  {
229  _ac = new __DAAL_ALGORITHM_CONTAINER(batch, BatchContainer, algorithmFPType, method)(&_env);
230  _in = &input;
231  _result.reset(new ResultType());
232  }
233 };
235 } // namespace interface1
236 using interface1::BatchContainer;
237 using interface1::Batch;
238 
239 } // namespace daal::algorithms::gbt::classification::training
240 }
241 }
242 }
243 } // namespace daal
244 #endif // __LOGIT_BOOST_TRAINING_BATCH_H__
daal::algorithms::gbt::classification::training::interface1::BatchContainer
Provides methods to run implementations of Gradient Boosted Trees model-based training. This class is associated with daal::algorithms::gbt::classification::training::Batch class.
Definition: gbt_classification_training_batch.h:80
daal::algorithms::classifier::training::interface1::Input
Base class for the input objects in the training stage of the classification algorithms.
Definition: classifier_training_types.h:134
daal::services::interface1::Environment::_envStruct
The environment structure.
Definition: env_detect.h:95
daal::services::interface1::Status
Class that holds the results of API calls. In case of API routine failure it contains the list of err...
Definition: error_handling.h:491
daal
Definition: algorithm_base_common.h:57
daal::algorithms::classifier::interface1::Parameter
Base class for the parameters of the classification algorithm.
Definition: classifier_model.h:81
daal::algorithms::gbt::classification::training::interface1::Batch::~Batch
~Batch()
Definition: gbt_classification_training_batch.h:151
daal::algorithms::gbt::classification::training::interface1::Batch::parameter
ParameterType & parameter()
Definition: gbt_classification_training_batch.h:160
daal::algorithms::gbt::classification::training::interface1::Batch::getInput
InputType * getInput() DAAL_C11_OVERRIDE
Definition: gbt_classification_training_batch.h:172
daal::algorithms::gbt::classification::training::interface1::Batch::Batch
Batch(size_t nClasses)
Definition: gbt_classification_training_batch.h:132
daal::batch
Definition: daal_defines.h:132
daal::services::interface1::SharedPtr
Shared pointer that retains shared ownership of an object through a pointer. Several SharedPtr object...
Definition: daal_shared_ptr.h:187
daal::algorithms::gbt::classification::training::interface1::Batch::getResult
ResultPtr getResult()
Definition: gbt_classification_training_batch.h:184
daal::services::interface1::SharedPtr::get
T * get() const
Definition: daal_shared_ptr.h:332
daal::algorithms::gbt::classification::training::interface1::Batch
Trains model of the Gradient Boosted Trees algorithms in the batch processing mode.
Definition: gbt_classification_training_batch.h:117
daal::algorithms::gbt::classification::training::interface1::Batch::parameter
const ParameterType & parameter() const
Definition: gbt_classification_training_batch.h:166
daal::algorithms::classifier::training::interface1::Batch
Algorithm class for training the classifier model.
Definition: classifier_training_batch.h:82
daal::algorithms::gbt::classification::training::interface1::Parameter
Gradient Boosted Trees algorithm parameters.
Definition: gbt_classification_training_types.h:108
daal::algorithms::gbt::classification::training::interface1::Batch::clone
services::SharedPtr< Batch< algorithmFPType, method > > clone() const
Definition: gbt_classification_training_batch.h:205
daal::algorithms::classifier::training::interface1::Result
Provides methods to access final results obtained with the compute() method in the batch processing m...
Definition: classifier_training_types.h:222
daal::algorithms::gbt::classification::training::interface1::Batch::resetResult
services::Status resetResult() DAAL_C11_OVERRIDE
Definition: gbt_classification_training_batch.h:192
daal::algorithms::gbt::classification::training::interface1::Result
Provides methods to access the result obtained with the compute() method of model-based training...
Definition: gbt_classification_training_types.h:123
daal::algorithms::gbt::classification::training::interface1::Batch::input
InputType input
Definition: gbt_classification_training_batch.h:126
daal::algorithms::gbt::classification::training::interface1::Batch::Batch
Batch(const Batch< algorithmFPType, method > &other)
Definition: gbt_classification_training_batch.h:144
daal::algorithms::gbt::classification::training::interface1::Batch::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: gbt_classification_training_batch.h:178
daal::services::ErrorNullResult
Definition: error_indexes.h:122
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:76

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