C++ API Reference for Intel® Data Analytics Acceleration Library 2019 Update 4

multinomial_naive_bayes_training_distributed.h
1 /* file: multinomial_naive_bayes_training_distributed.h */
2 /*******************************************************************************
3 * Copyright 2014-2019 Intel Corporation.
4 *
5 * This software and the related documents are Intel copyrighted materials, and
6 * your use of them is governed by the express license under which they were
7 * provided to you (License). Unless the License provides otherwise, you may not
8 * use, modify, copy, publish, distribute, disclose or transmit this software or
9 * the related documents without Intel's prior written permission.
10 *
11 * This software and the related documents are provided as is, with no express
12 * or implied warranties, other than those that are expressly stated in the
13 * License.
14 *******************************************************************************/
15 
16 /*
17 //++
18 // Implementation of the interface for multinomial naive Bayes model-based training
19 // in the distributed processing mode
20 //--
21 */
22 
23 #ifndef __NAIVE_BAYES_TRAINING_DISTRIBUTED_H__
24 #define __NAIVE_BAYES_TRAINING_DISTRIBUTED_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "multinomial_naive_bayes_training_types.h"
28 
29 namespace daal
30 {
31 namespace algorithms
32 {
33 namespace multinomial_naive_bayes
34 {
35 namespace training
36 {
37 
38 namespace interface1
39 {
53 template<ComputeStep step, typename algorithmFPType, Method method, CpuType cpu>
54 class DAAL_EXPORT DistributedContainer;
55 
60 template<typename algorithmFPType, Method method, CpuType cpu>
61 class DAAL_EXPORT DistributedContainer<step2Master, algorithmFPType, method, cpu> : public TrainingContainerIface<distributed>
62 {
63 public:
69  DistributedContainer(daal::services::Environment::env *daalEnv);
71  ~DistributedContainer();
72 
79  services::Status compute() DAAL_C11_OVERRIDE;
86  services::Status finalizeCompute() DAAL_C11_OVERRIDE;
87 };
88 
101 template<ComputeStep step, typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = defaultDense>
102 class DAAL_EXPORT Distributed {};
103 
117 template<typename algorithmFPType, Method method>
118 class DAAL_EXPORT Distributed<step1Local, algorithmFPType, method> : public Online<algorithmFPType, method>
119 {
120 public:
121  typedef Online<algorithmFPType, method> super;
122 
123  typedef typename super::InputType InputType;
124  typedef typename super::ParameterType ParameterType;
125  typedef typename super::ResultType ResultType;
126  typedef typename super::PartialResultType PartialResultType;
127 
132  Distributed(size_t nClasses) : Online<algorithmFPType, method>::Online(nClasses) {}
133 
140  Distributed(const Distributed<step1Local, algorithmFPType, method> &other) :
141  Online<algorithmFPType, method>(other)
142  {}
143 
149  services::SharedPtr<Distributed<step1Local, algorithmFPType, method> > clone() const
150  {
151  return services::SharedPtr<Distributed<step1Local, algorithmFPType, method> >(cloneImpl());
152  }
153 
154 protected:
155  virtual Distributed<step1Local, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
156  {
157  return new Distributed<step1Local, algorithmFPType, method>(*this);
158  }
159 };
160 
174 template<typename algorithmFPType, Method method>
175 class DAAL_EXPORT Distributed<step2Master, algorithmFPType, method> : public Training<distributed>
176 {
177 public:
178  typedef algorithms::multinomial_naive_bayes::training::DistributedInput InputType;
179  typedef algorithms::multinomial_naive_bayes::Parameter ParameterType;
180  typedef algorithms::multinomial_naive_bayes::training::Result ResultType;
181  typedef algorithms::multinomial_naive_bayes::training::PartialResult PartialResultType;
182 
183  ParameterType parameter;
184  InputType input;
190  Distributed(size_t nClasses) : parameter(nClasses)
191  {
192  initialize();
193  }
194 
201  Distributed(const Distributed<step2Master, algorithmFPType, method> &other) :
202  Training<distributed>(other), input(other.input), parameter(other.parameter)
203  {
204  initialize();
205  }
206 
207  virtual ~Distributed() {}
208 
213  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
214 
219  services::Status setPartialResult(const PartialResultPtr& partialResult)
220  {
221  DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
222  _partialResult = partialResult;
223  _pres = _partialResult.get();
224  return services::Status();
225  }
226 
231  PartialResultPtr getPartialResult() { return _partialResult; }
232 
239  services::Status setResult(const ResultPtr& result)
240  {
241  DAAL_CHECK(result, services::ErrorNullResult)
242  _result = result;
243  _res = _result.get();
244  return services::Status();
245  }
246 
251  ResultPtr getResult()
252  {
253  return ResultType::cast(_result);
254  }
255 
261  services::Status checkFinalizeComputeParams() DAAL_C11_OVERRIDE
262  {
263  PartialResultPtr partialResult = getPartialResult();
264  DAAL_CHECK(partialResult, services::ErrorNullResult);
265  services::Status s;
266  DAAL_CHECK_STATUS(s, partialResult->check(_par, method));
267  ResultPtr result = getResult();
268  DAAL_CHECK(result, services::ErrorNullResult);
269  DAAL_CHECK_STATUS(s, result->check(_pres, _par, method));
270  return s;
271  }
272 
278  services::SharedPtr<Distributed<step2Master, algorithmFPType, method> > clone() const
279  {
280  return services::SharedPtr<Distributed<step2Master, algorithmFPType, method> >(cloneImpl());
281  }
282 
283 protected:
284  PartialResultPtr _partialResult;
285  ResultPtr _result;
286 
287  virtual Distributed<step2Master, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
288  {
289  return new Distributed<step2Master, algorithmFPType, method>(*this);
290  }
291 
292  services::Status allocateResult() DAAL_C11_OVERRIDE
293  {
294  PartialResultPtr pres = getPartialResult();
295  ResultPtr res = getResult();
296  services::Status s = res->template allocate<algorithmFPType>(pres.get(), &parameter, (int)method);
297  _res = _result.get();
298  return s;
299  }
300 
301  services::Status allocatePartialResult() DAAL_C11_OVERRIDE
302  {
303  PartialResultPtr pres = getPartialResult();
304  services::Status s = pres->template allocate<algorithmFPType>((classifier::training::InputIface *)(&input), &parameter, (int)method);
305  _pres = _partialResult.get();
306  return s;
307  }
308 
309  services::Status initializePartialResult() DAAL_C11_OVERRIDE
310  {
311  return services::Status();
312  }
313 
314  void initialize()
315  {
316  _ac = new __DAAL_ALGORITHM_CONTAINER(distributed, DistributedContainer, step2Master, algorithmFPType, method)(&_env);
317  _in = &input;
318  _par = &parameter;
319  _result.reset(new ResultType());
320  _partialResult.reset(new PartialResultType());
321  }
322 };
324 } // namespace interface1
325 using interface1::DistributedContainer;
326 using interface1::Distributed;
327 
328 } // namespace training
329 } // namespace multinomial_naive_bayes
330 } // namespace algorithms
331 } //namespace daal
332 #endif
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::setResult
services::Status setResult(const ResultPtr &result)
Definition: multinomial_naive_bayes_training_distributed.h:239
daal
Definition: algorithm_base_common.h:31
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step1Local, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step1Local, algorithmFPType, method > > clone() const
Definition: multinomial_naive_bayes_training_distributed.h:149
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::getPartialResult
PartialResultPtr getPartialResult()
Definition: multinomial_naive_bayes_training_distributed.h:231
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step1Local, algorithmFPType, method >
Algorithm class for training Naive Bayes partial model in the distributed processing mode...
Definition: multinomial_naive_bayes_training_distributed.h:118
daal::services::ErrorNullPartialResult
Definition: error_indexes.h:105
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::setPartialResult
services::Status setPartialResult(const PartialResultPtr &partialResult)
Definition: multinomial_naive_bayes_training_distributed.h:219
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::getResult
ResultPtr getResult()
Definition: multinomial_naive_bayes_training_distributed.h:251
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step1Local, algorithmFPType, method >::Distributed
Distributed(size_t nClasses)
Definition: multinomial_naive_bayes_training_distributed.h:132
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_distributed.h:213
daal::algorithms::kmeans::init::interface2::Distributed
class DAAL_EXPORT Distributed
Computes initial clusters for the K-Means algorithm in the distributed processing mode...
Definition: kmeans_init_distributed.h:275
daal::distributed
Definition: daal_defines.h:111
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::Distributed
Distributed(size_t nClasses)
Definition: multinomial_naive_bayes_training_distributed.h:190
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >
Algorithm class for training naive Bayes final model on the second step in the distributed processing...
Definition: multinomial_naive_bayes_training_distributed.h:175
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::Distributed
Distributed(const Distributed< step2Master, algorithmFPType, method > &other)
Definition: multinomial_naive_bayes_training_distributed.h:201
daal::algorithms::multinomial_naive_bayes::training::interface1::DistributedContainer
class DAAL_EXPORT DistributedContainer
Class containing methods to compute naive Bayes training results in the distributed processing mode...
Definition: multinomial_naive_bayes_training_distributed.h:54
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step1Local, algorithmFPType, method >::Distributed
Distributed(const Distributed< step1Local, algorithmFPType, method > &other)
Definition: multinomial_naive_bayes_training_distributed.h:140
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::parameter
ParameterType parameter
Definition: multinomial_naive_bayes_training_distributed.h:183
daal::step1Local
Definition: daal_defines.h:121
daal::step2Master
Definition: daal_defines.h:122
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step2Master, algorithmFPType, method > > clone() const
Definition: multinomial_naive_bayes_training_distributed.h:278
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed
Algorithm class for training naive Bayes model in the distributed processing mode.
Definition: multinomial_naive_bayes_training_distributed.h:102
daal::services::ErrorNullResult
Definition: error_indexes.h:96
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::input
InputType input
Definition: multinomial_naive_bayes_training_distributed.h:184
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:50
daal::algorithms::multinomial_naive_bayes::training::interface1::Online
Algorithm class for training naive Bayes model.
Definition: multinomial_naive_bayes_training_online.h:96
daal::algorithms::Training
Provides methods to train models that depend on the data provided. For example, these methods enable ...
Definition: training.h:60
daal::algorithms::multinomial_naive_bayes::training::interface1::Distributed< step2Master, algorithmFPType, method >::checkFinalizeComputeParams
services::Status checkFinalizeComputeParams() DAAL_C11_OVERRIDE
Definition: multinomial_naive_bayes_training_distributed.h:261

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