/*
 * Copyright (c) 2023, NVIDIA CORPORATION.
 *
 * 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.
 */
#pragma once

#include <layer.hpp>

namespace HugeCTR {

template <typename T>
class SoftmaxLayer : public Layer {
 public:
  SoftmaxLayer(const core23::Tensor& input_tensor, const core23::Tensor& output_tensor,
               const std::shared_ptr<GPUResource>& gpu_resource);
  /**
   * A method of implementing the forward pass of SoftmaxLayer
   * @param stream CUDA stream where the forward propagation is executed
   */
  void fprop(bool is_train) override;
  /**
   * A method of implementing the backward pass of SoftmaxLayer
   * @param stream CUDA stream where the backward propagation is executed
   */
  void bprop() override;

  core23::Tensor& get_softmax_out_tensor() { return softmax_out23_; }

  /*
   * initialize for identity tensor
   */
  void initialize() final;

 private:
  size_t dims_;
  size_t n_rows_;
  size_t hidden_size_;
  size_t len_;
  core23::Tensor workspace23_;
  core23::Tensor identity23_;
  core23::Tensor softmax_out23_;
};

}  // namespace HugeCTR
