SGD.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __ONERT_BACKEND_TRAIN_OPTIMIZER_SGD_H__
#define __ONERT_BACKEND_TRAIN_OPTIMIZER_SGD_H__
 
#include <exec/train/optimizer/Optimizer.h>
 
namespace onert::backend::train::optimizer
{
 
class SGD : public exec::train::optimizer::Optimizer
{
public:
  using UpdateFactors = exec::train::optimizer::UpdateFactors;
 
public:
  struct Property
  {
    double momentum{0.0};
    bool nesterov{false};
  };
 
public:
  explicit SGD() : _props{}, _learning_rate{0.01} {}
  explicit SGD(const Property &props) : _props{props}, _learning_rate{0.01} {}
  explicit SGD(double lr) : _props{}, _learning_rate{lr} {}
  explicit SGD(const Property &props, double lr) : _props{props}, _learning_rate{lr} {}
 
public:
  std::string name() const override { return std::string{"SGD"}; }
 
  double getLearningRate(uint32_t iteration = 0) const override;
 
  virtual uint32_t getVarCount() const override { return 0; };
 
  void applyGradient(const UpdateFactors &factors) const override;
 
private:
  Property _props;
  double _learning_rate;
};
 
} // namespace onert::backend::train::optimizer
 
#endif // __ONERT_BACKEND_TRAIN_OPTIMIZER_SGD_H__