linear_updater.h

Go to the documentation of this file.

/*
 * Copyright 2018 by Contributors
 */
#pragma once
 
#include <dmlc/registry.h>
#include <xgboost/base.h>
#include <xgboost/data.h>
#include <xgboost/host_device_vector.h>
#include <xgboost/model.h>
 
#include <functional>
#include <string>
#include <utility>
#include <vector>
 
 
namespace xgboost {
 
class Json;
struct Context;
 
namespace gbm {
class GBLinearModel;
}  // namespace gbm
 
class LinearUpdater : public Configurable {
 protected:
  Context const* ctx_;
 
 public:
  ~LinearUpdater() override = default;
  virtual void Configure(
      const std::vector<std::pair<std::string, std::string> >& args) = 0;
 
  virtual void Update(HostDeviceVector<GradientPair>* in_gpair, DMatrix* data,
                      gbm::GBLinearModel* model,
                      double sum_instance_weight) = 0;
 
  static LinearUpdater* Create(const std::string& name, Context const*);
};
 
struct LinearUpdaterReg
    : public dmlc::FunctionRegEntryBase<LinearUpdaterReg,
                                        std::function<LinearUpdater*()> > {};
 
#define XGBOOST_REGISTER_LINEAR_UPDATER(UniqueId, Name)                        \
  static DMLC_ATTRIBUTE_UNUSED ::xgboost::LinearUpdaterReg&                    \
      __make_##LinearUpdaterReg##_##UniqueId##__ =                             \
          ::dmlc::Registry< ::xgboost::LinearUpdaterReg>::Get()->__REGISTER__( \
              Name)
 
}  // namespace xgboost