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

implicit_als_training_init_distributed.h
1 /* file: implicit_als_training_init_distributed.h */
2 /*******************************************************************************
3 * Copyright 2014-2018 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 the implicit ALS initialization algorithm
19 // in the distributed processing mode
20 //--
21 */
22 
23 #ifndef __IMPLICIT_ALS_TRAINING_INIT_DISTRIBUTED_H__
24 #define __IMPLICIT_ALS_TRAINING_INIT_DISTRIBUTED_H__
25 
26 #include "algorithms/algorithm.h"
27 #include "algorithms/implicit_als/implicit_als_training_init_types.h"
28 
29 namespace daal
30 {
31 namespace algorithms
32 {
33 namespace implicit_als
34 {
35 namespace training
36 {
37 namespace init
38 {
39 
40 namespace interface1
41 {
52 template<ComputeStep step, typename algorithmFPType, Method method, CpuType cpu>
53 class DAAL_EXPORT DistributedContainer {};
54 
59 template<typename algorithmFPType, Method method, CpuType cpu>
60 class DAAL_EXPORT DistributedContainer<step1Local, algorithmFPType, method, cpu> : public
61  TrainingContainerIface<distributed>
62 {
63 public:
69  DistributedContainer(daal::services::Environment::env *daalEnv);
71  ~DistributedContainer();
76  services::Status compute() DAAL_C11_OVERRIDE;
81  services::Status finalizeCompute() DAAL_C11_OVERRIDE { return services::Status(); }
82 };
83 
88 template<typename algorithmFPType, Method method, CpuType cpu>
89 class DAAL_EXPORT DistributedContainer<step2Local, algorithmFPType, method, cpu> : public
90  TrainingContainerIface<distributed>
91 {
92 public:
98  DistributedContainer(daal::services::Environment::env *daalEnv);
100  ~DistributedContainer();
105  services::Status compute() DAAL_C11_OVERRIDE;
110  services::Status finalizeCompute() DAAL_C11_OVERRIDE { return services::Status(); }
111 };
112 
113 
126 template<ComputeStep step, typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = fastCSR>
127 class DAAL_EXPORT Distributed {};
128 
140 template<typename algorithmFPType, Method method>
141 class DAAL_EXPORT Distributed<step1Local, algorithmFPType, method> : public Training<distributed>
142 {
143 public:
144  typedef algorithms::implicit_als::training::init::DistributedInput<step1Local> InputType;
145  typedef algorithms::implicit_als::training::init::DistributedParameter ParameterType;
146  typedef algorithms::implicit_als::training::init::Result ResultType;
147  typedef algorithms::implicit_als::training::init::PartialResult PartialResultType;
148 
149  DistributedInput<step1Local> input;
150  ParameterType parameter;
153  Distributed()
154  {
155  initialize();
156  }
157 
164  Distributed(const Distributed<step1Local, algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
165  {
166  initialize();
167  }
168 
173  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
174 
179  services::Status setPartialResult(const PartialResultPtr& partialResult)
180  {
181  DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
182  _partialResult = partialResult;
183  _pres = _partialResult.get();
184  return services::Status();
185  }
186 
191  PartialResultPtr getPartialResult() { return _partialResult; }
192 
198  services::SharedPtr<Distributed<step1Local, algorithmFPType, method> > clone() const
199  {
200  return services::SharedPtr<Distributed<step1Local, algorithmFPType, method> >(cloneImpl());
201  }
202 
203 protected:
204  PartialResultPtr _partialResult;
205 
206  virtual Distributed<step1Local, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
207  {
208  return new Distributed<step1Local, algorithmFPType, method>(*this);
209  }
210 
211  services::Status allocateResult() DAAL_C11_OVERRIDE
212  {
213  return services::Status();
214  }
215 
216  services::Status allocatePartialResult() DAAL_C11_OVERRIDE
217  {
218  services::Status s = _partialResult->allocate<algorithmFPType>(&input, &parameter, method);
219  _pres = _partialResult.get();
220  return s;
221  }
222 
223  services::Status initializePartialResult() DAAL_C11_OVERRIDE
224  {
225  return services::Status();
226  }
227 
228  void initialize()
229  {
230  _ac = new __DAAL_ALGORITHM_CONTAINER(distributed, DistributedContainer, step1Local, algorithmFPType, method)(&_env);
231  _in = &input;
232  _par = &parameter;
233  _partialResult.reset(new PartialResultType());
234  }
235 };
236 
248 template<typename algorithmFPType, Method method>
249 class DAAL_EXPORT Distributed<step2Local, algorithmFPType, method> : public Training<distributed>
250 {
251 public:
252  typedef algorithms::implicit_als::training::init::DistributedInput<step2Local> InputType;
253  typedef algorithms::implicit_als::training::init::Result ResultType;
254  typedef algorithms::implicit_als::training::init::DistributedPartialResultStep2 PartialResultType;
255 
256  DistributedInput<step2Local> input;
259  Distributed()
260  {
261  initialize();
262  }
263 
270  Distributed(const Distributed<step2Local, algorithmFPType, method> &other)
271  {
272  initialize();
273  input.set(inputOfStep2FromStep1, other.input.get(inputOfStep2FromStep1));
274  }
275 
280  virtual int getMethod() const DAAL_C11_OVERRIDE { return(int)method; }
281 
286  services::Status setPartialResult(const DistributedPartialResultStep2Ptr& partialResult)
287  {
288  DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
289  _partialResult = partialResult;
290  _pres = _partialResult.get();
291  return services::Status();
292  }
293 
298  DistributedPartialResultStep2Ptr getPartialResult() { return _partialResult; }
299 
305  services::SharedPtr<Distributed<step2Local, algorithmFPType, method> > clone() const
306  {
307  return services::SharedPtr<Distributed<step2Local, algorithmFPType, method> >(cloneImpl());
308  }
309 
310 protected:
311  DistributedPartialResultStep2Ptr _partialResult;
312 
313  virtual Distributed<step2Local, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
314  {
315  return new Distributed<step2Local, algorithmFPType, method>(*this);
316  }
317 
318  services::Status allocateResult() DAAL_C11_OVERRIDE
319  {
320  return services::Status();
321  }
322 
323  services::Status allocatePartialResult() DAAL_C11_OVERRIDE
324  {
325  services::Status s = _partialResult->allocate<algorithmFPType>(&input, NULL, method);
326  _pres = _partialResult.get();
327  return s;
328  }
329 
330  services::Status initializePartialResult() DAAL_C11_OVERRIDE
331  {
332  return services::Status();
333  }
334 
335  void initialize()
336  {
337  _ac = new __DAAL_ALGORITHM_CONTAINER(distributed, DistributedContainer, step2Local, algorithmFPType, method)(&_env);
338  _in = &input;
339  _par = NULL;
340  _partialResult.reset(new PartialResultType());
341  }
342 };
344 } // namespace interface1
345 using interface1::DistributedContainer;
346 using interface1::Distributed;
347 
348 }
349 }
350 }
351 }
352 }
353 
354 #endif
daal::algorithms::implicit_als::training::init::interface1::DistributedContainer< step2Local, algorithmFPType, method, cpu >::finalizeCompute
services::Status finalizeCompute() DAAL_C11_OVERRIDE
Definition: implicit_als_training_init_distributed.h:110
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::getPartialResult
PartialResultPtr getPartialResult()
Definition: implicit_als_training_init_distributed.h:191
daal::algorithms::implicit_als::training::init::inputOfStep2FromStep1
Definition: implicit_als_training_init_types.h:77
daal::step2Local
Definition: daal_defines.h:122
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >
Initializes the implicit ALS model in the second step of the distributed processing mode...
Definition: implicit_als_training_init_distributed.h:249
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_init_distributed.h:280
daal
Definition: algorithm_base_common.h:31
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_init_distributed.h:173
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >::input
DistributedInput< step2Local > input
Definition: implicit_als_training_init_distributed.h:256
daal::algorithms::implicit_als::training::init::interface1::DistributedContainer
Class containing methods to compute the results of the implicit ALS initialization algorithm in the d...
Definition: implicit_als_training_init_distributed.h:53
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::Distributed
Distributed(const Distributed< step1Local, algorithmFPType, method > &other)
Definition: implicit_als_training_init_distributed.h:164
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::setPartialResult
services::Status setPartialResult(const PartialResultPtr &partialResult)
Definition: implicit_als_training_init_distributed.h:179
daal::services::ErrorNullPartialResult
Definition: error_indexes.h:105
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step1Local, algorithmFPType, method > > clone() const
Definition: implicit_als_training_init_distributed.h:198
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >::setPartialResult
services::Status setPartialResult(const DistributedPartialResultStep2Ptr &partialResult)
Definition: implicit_als_training_init_distributed.h:286
daal::algorithms::implicit_als::training::init::interface1::DistributedInput< step2Local >::set
void set(Step2LocalInputId id, const data_management::KeyValueDataCollectionPtr &ptr)
daal::algorithms::kmeans::init::interface1::Distributed
class DAAL_EXPORT Distributed
Computes initial clusters for the K-Means algorithm in the distributed processing mode...
Definition: kmeans_init_distributed.h:255
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >::getPartialResult
DistributedPartialResultStep2Ptr getPartialResult()
Definition: implicit_als_training_init_distributed.h:298
daal::distributed
Definition: daal_defines.h:107
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >
Initializes the implicit ALS model in the first step of the distributed processing mode...
Definition: implicit_als_training_init_distributed.h:141
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >::Distributed
Distributed(const Distributed< step2Local, algorithmFPType, method > &other)
Definition: implicit_als_training_init_distributed.h:270
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::Distributed
Distributed()
Definition: implicit_als_training_init_distributed.h:153
daal::algorithms::implicit_als::training::init::interface1::DistributedInput< step2Local >::get
data_management::KeyValueDataCollectionPtr get(Step2LocalInputId id) const
daal::algorithms::implicit_als::training::init::interface1::DistributedContainer< step1Local, algorithmFPType, method, cpu >::finalizeCompute
services::Status finalizeCompute() DAAL_C11_OVERRIDE
Definition: implicit_als_training_init_distributed.h:81
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step2Local, algorithmFPType, method > > clone() const
Definition: implicit_als_training_init_distributed.h:305
daal::algorithms::kmeans::interface1::DistributedContainer
class DAAL_EXPORT DistributedContainer
Provides methods to run implementations of the K-Means algorithm. This class is associated with the d...
Definition: kmeans_distributed.h:55
daal::step1Local
Definition: daal_defines.h:117
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::input
DistributedInput< step1Local > input
Definition: implicit_als_training_init_distributed.h:149
daal::algorithms::implicit_als::training::init::interface1::Distributed< step2Local, algorithmFPType, method >::Distributed
Distributed()
Definition: implicit_als_training_init_distributed.h:259
daal::algorithms::implicit_als::training::init::interface1::DistributedInput< step2Local >
Input objects for the implicit ALS initialization algorithm in the second step of the distributed pro...
Definition: implicit_als_training_init_types.h:273
daal::algorithms::implicit_als::training::init::interface1::DistributedInput< step1Local >
Input objects for the implicit ALS initialization algorithm in the first step of the distributed proc...
Definition: implicit_als_training_init_types.h:252
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:50
daal::algorithms::implicit_als::training::init::interface1::Distributed
Initializes the implicit ALS model in the distributed processing mode.
Definition: implicit_als_training_init_distributed.h:127
daal::algorithms::implicit_als::training::init::interface1::Distributed< step1Local, algorithmFPType, method >::parameter
ParameterType parameter
Definition: implicit_als_training_init_distributed.h:150
daal::algorithms::Training
Provides methods to train models that depend on the data provided. For example, these methods enable ...
Definition: training.h:60

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