25 #ifndef __IMPLICIT_ALS_TRAINING_DISTRIBUTED_H__
26 #define __IMPLICIT_ALS_TRAINING_DISTRIBUTED_H__
28 #include "algorithms/algorithm.h"
29 #include "algorithms/implicit_als/implicit_als_training_types.h"
35 namespace implicit_als
52 template<ComputeStep step,
typename algorithmFPType, Method method, CpuType cpu>
53 class DistributedContainer
60 template<
typename algorithmFPType, Method method, CpuType cpu>
61 class DistributedContainer<step1Local, algorithmFPType, method, cpu> :
public
62 TrainingContainerIface<distributed>
70 DistributedContainer(daal::services::Environment::env *daalEnv);
72 ~DistributedContainer();
78 services::Status compute() DAAL_C11_OVERRIDE;
83 services::Status finalizeCompute() DAAL_C11_OVERRIDE;
90 template<
typename algorithmFPType, Method method, CpuType cpu>
91 class DistributedContainer<step2Master, algorithmFPType, method, cpu> :
public
92 TrainingContainerIface<distributed>
100 DistributedContainer(daal::services::Environment::env *daalEnv);
102 ~DistributedContainer();
108 services::Status compute() DAAL_C11_OVERRIDE;
113 services::Status finalizeCompute() DAAL_C11_OVERRIDE;
120 template<
typename algorithmFPType, Method method, CpuType cpu>
121 class DistributedContainer<step3Local, algorithmFPType, method, cpu> :
public
122 TrainingContainerIface<distributed>
130 DistributedContainer(daal::services::Environment::env *daalEnv);
132 ~DistributedContainer();
138 services::Status compute() DAAL_C11_OVERRIDE;
143 services::Status finalizeCompute() DAAL_C11_OVERRIDE;
150 template<
typename algorithmFPType, Method method, CpuType cpu>
151 class DistributedContainer<step4Local, algorithmFPType, method, cpu> :
public
152 TrainingContainerIface<distributed>
160 DistributedContainer(daal::services::Environment::env *daalEnv);
162 ~DistributedContainer();
168 services::Status compute() DAAL_C11_OVERRIDE;
173 services::Status finalizeCompute() DAAL_C11_OVERRIDE;
188 template<ComputeStep step,
typename algorithmFPType = DAAL_ALGORITHM_FP_TYPE, Method method = fastCSR>
189 class DAAL_EXPORT Distributed :
public Training<distributed> {};
206 template<
typename algorithmFPType, Method method>
207 class DAAL_EXPORT Distributed<step1Local, algorithmFPType, method> :
public Training<distributed>
210 typedef algorithms::implicit_als::training::DistributedInput<step1Local> InputType;
211 typedef algorithms::implicit_als::Parameter ParameterType;
212 typedef algorithms::implicit_als::training::Result ResultType;
213 typedef algorithms::implicit_als::training::DistributedPartialResultStep1 PartialResultType;
215 DistributedInput<step1Local> input;
216 ParameterType parameter;
230 Distributed(
const Distributed<step1Local, algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
239 virtual int getMethod() const DAAL_C11_OVERRIDE {
return(
int)method; }
247 services::Status setPartialResult(
const DistributedPartialResultStep1Ptr& partialResult)
249 DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
250 _partialResult = partialResult;
251 _pres = _partialResult.get();
252 return services::Status();
261 DistributedPartialResultStep1Ptr getPartialResult() {
return _partialResult; }
268 services::SharedPtr<Distributed<step1Local, algorithmFPType, method> > clone()
const
270 return services::SharedPtr<Distributed<step1Local, algorithmFPType, method> >(cloneImpl());
274 DistributedPartialResultStep1Ptr _partialResult;
276 virtual Distributed<step1Local, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
278 return new Distributed<step1Local, algorithmFPType, method>(*this);
281 services::Status allocateResult() DAAL_C11_OVERRIDE
283 return services::Status();
286 services::Status allocatePartialResult() DAAL_C11_OVERRIDE
288 services::Status s = _partialResult->allocate<algorithmFPType>(&input, ¶meter, method);
289 _pres = _partialResult.get();
293 services::Status initializePartialResult() DAAL_C11_OVERRIDE
295 return services::Status();
300 _ac =
new __DAAL_ALGORITHM_CONTAINER(distributed, DistributedContainer, step1Local, algorithmFPType, method)(&_env);
303 _partialResult.reset(
new PartialResultType());
322 template<
typename algorithmFPType, Method method>
323 class DAAL_EXPORT Distributed<step2Master, algorithmFPType, method> :
public Training<distributed>
326 typedef algorithms::implicit_als::training::DistributedInput<step2Master> InputType;
327 typedef algorithms::implicit_als::Parameter ParameterType;
328 typedef algorithms::implicit_als::training::Result ResultType;
329 typedef algorithms::implicit_als::training::DistributedPartialResultStep2 PartialResultType;
331 DistributedInput<step2Master> input;
332 ParameterType parameter;
346 Distributed(
const Distributed<step2Master, algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
355 virtual int getMethod() const DAAL_C11_OVERRIDE {
return(
int)method; }
363 services::Status setPartialResult(
const DistributedPartialResultStep2Ptr& partialResult)
365 DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
366 _partialResult = partialResult;
367 _pres = _partialResult.get();
368 return services::Status();
377 DistributedPartialResultStep2Ptr getPartialResult() {
return _partialResult; }
384 services::SharedPtr<Distributed<step2Master, algorithmFPType, method> > clone()
const
386 return services::SharedPtr<Distributed<step2Master, algorithmFPType, method> >(cloneImpl());
390 DistributedPartialResultStep2Ptr _partialResult;
392 virtual Distributed<step2Master, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
394 return new Distributed<step2Master, algorithmFPType, method>(*this);
397 services::Status allocateResult() DAAL_C11_OVERRIDE
399 return services::Status();
402 services::Status allocatePartialResult() DAAL_C11_OVERRIDE
404 services::Status s = _partialResult->allocate<algorithmFPType>(&input, ¶meter, method);
405 _pres = _partialResult.get();
409 services::Status initializePartialResult() DAAL_C11_OVERRIDE
411 return services::Status();
416 _ac =
new __DAAL_ALGORITHM_CONTAINER(distributed, DistributedContainer, step2Master, algorithmFPType, method)(&_env);
419 _partialResult.reset(
new PartialResultType());
439 template<
typename algorithmFPType, Method method>
440 class DAAL_EXPORT Distributed<step3Local, algorithmFPType, method> :
public Training<distributed>
443 typedef algorithms::implicit_als::training::DistributedInput<step3Local> InputType;
444 typedef algorithms::implicit_als::Parameter ParameterType;
445 typedef algorithms::implicit_als::training::Result ResultType;
446 typedef algorithms::implicit_als::training::DistributedPartialResultStep3 PartialResultType;
448 DistributedInput<step3Local> input;
449 ParameterType parameter;
463 Distributed(
const Distributed<step3Local, algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
472 virtual int getMethod() const DAAL_C11_OVERRIDE {
return(
int)method; }
480 services::Status setPartialResult(
const DistributedPartialResultStep3Ptr& partialResult)
482 DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
483 _partialResult = partialResult;
484 _pres = _partialResult.get();
485 return services::Status();
494 DistributedPartialResultStep3Ptr getPartialResult() {
return _partialResult; }
501 services::SharedPtr<Distributed<step3Local, algorithmFPType, method> > clone()
const
503 return services::SharedPtr<Distributed<step3Local, algorithmFPType, method> >(cloneImpl());
507 DistributedPartialResultStep3Ptr _partialResult;
509 virtual Distributed<step3Local, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
511 return new Distributed<step3Local, algorithmFPType, method>(*this);
514 services::Status allocateResult() DAAL_C11_OVERRIDE
516 return services::Status();
519 services::Status allocatePartialResult() DAAL_C11_OVERRIDE
521 services::Status s = _partialResult->allocate<algorithmFPType>(&input, ¶meter, method);
522 _pres = _partialResult.get();
526 services::Status initializePartialResult() DAAL_C11_OVERRIDE
528 return services::Status();
533 _ac =
new __DAAL_ALGORITHM_CONTAINER(distributed, DistributedContainer, step3Local, algorithmFPType, method)(&_env);
536 _partialResult.reset(
new PartialResultType());
555 template<
typename algorithmFPType, Method method>
556 class DAAL_EXPORT Distributed<step4Local, algorithmFPType, method> :
public Training<distributed>
559 typedef algorithms::implicit_als::training::DistributedInput<step4Local> InputType;
560 typedef algorithms::implicit_als::Parameter ParameterType;
561 typedef algorithms::implicit_als::training::Result ResultType;
562 typedef algorithms::implicit_als::training::DistributedPartialResultStep4 PartialResultType;
564 DistributedInput<step4Local> input;
565 ParameterType parameter;
579 Distributed(
const Distributed<step4Local, algorithmFPType, method> &other) : input(other.input), parameter(other.parameter)
588 virtual int getMethod() const DAAL_C11_OVERRIDE {
return(
int)method; }
596 services::Status setPartialResult(
const DistributedPartialResultStep4Ptr& partialResult)
598 DAAL_CHECK(partialResult, services::ErrorNullPartialResult);
599 _partialResult = partialResult;
600 _pres = _partialResult.get();
601 return services::Status();
610 DistributedPartialResultStep4Ptr getPartialResult() {
return _partialResult; }
617 services::SharedPtr<Distributed<step4Local, algorithmFPType, method> > clone()
const
619 return services::SharedPtr<Distributed<step4Local, algorithmFPType, method> >(cloneImpl());
623 DistributedPartialResultStep4Ptr _partialResult;
625 virtual Distributed<step4Local, algorithmFPType, method> * cloneImpl() const DAAL_C11_OVERRIDE
627 return new Distributed<step4Local, algorithmFPType, method>(*this);
630 services::Status allocateResult() DAAL_C11_OVERRIDE
632 return services::Status();
635 services::Status allocatePartialResult() DAAL_C11_OVERRIDE
637 services::Status s = _partialResult->allocate<algorithmFPType>(&input, ¶meter, method);
638 _pres = _partialResult.get();
642 services::Status initializePartialResult() DAAL_C11_OVERRIDE
644 return services::Status();
649 _ac =
new __DAAL_ALGORITHM_CONTAINER(distributed, DistributedContainer, step4Local, algorithmFPType, method)(&_env);
652 _partialResult.reset(
new PartialResultType());
657 using interface1::DistributedContainer;
658 using interface1::Distributed;
daal::step1Local
Definition: daal_defines.h:123
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::setPartialResult
services::Status setPartialResult(const DistributedPartialResultStep4Ptr &partialResult)
Definition: implicit_als_training_distributed.h:596
daal::algorithms::implicit_als::training::interface1::Distributed
Trains the implicit ALS model in the distributed processing mode.
Definition: implicit_als_training_distributed.h:189
daal::algorithms::implicit_als::training::interface1::DistributedInput< step3Local >
Input objects for the implicit ALS training algorithm in the third step of the distributed processing...
Definition: implicit_als_training_types.h:498
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::Distributed
Distributed(const Distributed< step1Local, algorithmFPType, method > &other)
Definition: implicit_als_training_distributed.h:230
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >
Trains the implicit ALS model in the second step of the distributed processing mode.
Definition: implicit_als_training_distributed.h:323
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::parameter
ParameterType parameter
Definition: implicit_als_training_distributed.h:565
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step1Local, algorithmFPType, method > > clone() const
Definition: implicit_als_training_distributed.h:268
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step3Local, algorithmFPType, method > > clone() const
Definition: implicit_als_training_distributed.h:501
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::Distributed
Distributed(const Distributed< step4Local, algorithmFPType, method > &other)
Definition: implicit_als_training_distributed.h:579
daal::step2Master
Definition: daal_defines.h:124
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::getPartialResult
DistributedPartialResultStep2Ptr getPartialResult()
Definition: implicit_als_training_distributed.h:377
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::input
DistributedInput< step4Local > input
Definition: implicit_als_training_distributed.h:564
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::setPartialResult
services::Status setPartialResult(const DistributedPartialResultStep3Ptr &partialResult)
Definition: implicit_als_training_distributed.h:480
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::input
DistributedInput< step3Local > input
Definition: implicit_als_training_distributed.h:448
daal::algorithms::implicit_als::training::interface1::DistributedInput< step2Master >
Input objects for the implicit ALS training algorithm in the second step of the distributed processin...
Definition: implicit_als_training_types.h:394
daal::step3Local
Definition: daal_defines.h:125
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_distributed.h:239
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::input
DistributedInput< step2Master > input
Definition: implicit_als_training_distributed.h:331
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step4Local, algorithmFPType, method > > clone() const
Definition: implicit_als_training_distributed.h:617
daal::algorithms::kmeans::init::interface2::Distributed
class DAAL_EXPORT Distributed
Computes initial clusters for K-Means algorithm in the distributed processing mode.
Definition: kmeans_init_distributed.h:277
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::setPartialResult
services::Status setPartialResult(const DistributedPartialResultStep1Ptr &partialResult)
Definition: implicit_als_training_distributed.h:247
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::Distributed
Distributed()
Definition: implicit_als_training_distributed.h:568
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >
Trains the implicit ALS model in the first step of the distributed processing mode.
Definition: implicit_als_training_distributed.h:207
daal::algorithms::implicit_als::training::interface1::DistributedContainer
Class containing methods to compute the result of implicit ALS model-based training in the distribute...
Definition: implicit_als_training_distributed.h:53
daal::step4Local
Definition: daal_defines.h:126
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_distributed.h:472
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >
Trains the implicit ALS model in the fourth step of the distributed processing mode.
Definition: implicit_als_training_distributed.h:556
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::input
DistributedInput< step1Local > input
Definition: implicit_als_training_distributed.h:215
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_distributed.h:355
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::Distributed
Distributed()
Definition: implicit_als_training_distributed.h:452
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::parameter
ParameterType parameter
Definition: implicit_als_training_distributed.h:332
daal::algorithms::Training
Provides methods to train models that depend on the data provided. For example, these methods enable ...
Definition: training.h:62
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::Distributed
Distributed(const Distributed< step3Local, algorithmFPType, method > &other)
Definition: implicit_als_training_distributed.h:463
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::parameter
ParameterType parameter
Definition: implicit_als_training_distributed.h:449
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::getPartialResult
DistributedPartialResultStep4Ptr getPartialResult()
Definition: implicit_als_training_distributed.h:610
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::Distributed
Distributed()
Definition: implicit_als_training_distributed.h:335
daal::algorithms::implicit_als::training::interface1::DistributedInput< step1Local >
Input objects for the implicit ALS training algorithm in the first step of the distributed processing...
Definition: implicit_als_training_types.h:298
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::parameter
ParameterType parameter
Definition: implicit_als_training_distributed.h:216
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >
Trains the implicit ALS model in the third step of the distributed processing mode.
Definition: implicit_als_training_distributed.h:440
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::setPartialResult
services::Status setPartialResult(const DistributedPartialResultStep2Ptr &partialResult)
Definition: implicit_als_training_distributed.h:363
daal::algorithms::implicit_als::training::interface1::Distributed< step3Local, algorithmFPType, method >::getPartialResult
DistributedPartialResultStep3Ptr getPartialResult()
Definition: implicit_als_training_distributed.h:494
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::Distributed
Distributed(const Distributed< step2Master, algorithmFPType, method > &other)
Definition: implicit_als_training_distributed.h:346
daal::services::ErrorNullPartialResult
Definition: error_indexes.h:107
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::getPartialResult
DistributedPartialResultStep1Ptr getPartialResult()
Definition: implicit_als_training_distributed.h:261
daal::distributed
Definition: daal_defines.h:113
daal::algorithms::implicit_als::training::interface1::Distributed< step1Local, algorithmFPType, method >::Distributed
Distributed()
Definition: implicit_als_training_distributed.h:219
daal::algorithms::TrainingContainerIface
Abstract interface class that provides virtual methods to access and run implementations of the model...
Definition: training.h:52
daal::algorithms::implicit_als::training::interface1::DistributedInput< step4Local >
Input objects for the implicit ALS training algorithm in the fourth step of the distributed processin...
Definition: implicit_als_training_types.h:652
daal::algorithms::implicit_als::training::interface1::Distributed< step2Master, algorithmFPType, method >::clone
services::SharedPtr< Distributed< step2Master, algorithmFPType, method > > clone() const
Definition: implicit_als_training_distributed.h:384
daal::algorithms::implicit_als::training::interface1::Distributed< step4Local, algorithmFPType, method >::getMethod
virtual int getMethod() const DAAL_C11_OVERRIDE
Definition: implicit_als_training_distributed.h:588