/* Copyright (c) 2016 PaddlePaddle Authors. 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. */ #include "paddle/fluid/operators/fusion_lstm_op.h" #include #include "paddle/fluid/operators/math/blas.h" #include "paddle/fluid/operators/math/cpu_lstm_compute.h" #include "paddle/fluid/operators/math/cpu_vec.h" #include "paddle/fluid/operators/math/fc_compute.h" #include "paddle/fluid/operators/math/sequence2batch.h" #include "paddle/fluid/platform/cpu_info.h" namespace paddle { namespace operators { void FusionLSTMOp::InferShape(framework::InferShapeContext* ctx) const { PADDLE_ENFORCE(ctx->HasInput("X"), "Assert only one Input(X) of LSTM."); PADDLE_ENFORCE(ctx->HasInput("WeightX"), "Assert only one Input(WeightX) of LSTM."); PADDLE_ENFORCE(ctx->HasInput("WeightH"), "Assert only one Input(WeightH) of LSTM."); PADDLE_ENFORCE(ctx->HasInput("Bias"), "Assert only one Input(Bias) of LSTM."); PADDLE_ENFORCE(ctx->HasOutput("XX"), "Assert only one Output(XX) of LSTM."); PADDLE_ENFORCE(ctx->HasOutput("Hidden"), "Assert only one Output(Hidden) of LSTM."); PADDLE_ENFORCE(ctx->HasOutput("Cell"), "Assert only one Output(Cell) of LSTM."); auto x_dims = ctx->GetInputDim("X"); PADDLE_ENFORCE_EQ(x_dims.size(), 2, "Input(X)'s rank must be 2."); if (ctx->HasInput("H0")) { PADDLE_ENFORCE(ctx->HasInput("C0"), "Input(Cell) and Input(Hidden) of LSTM should not " "be null at the same time."); auto h_dims = ctx->GetInputDim("H0"); auto c_dims = ctx->GetInputDim("C0"); PADDLE_ENFORCE(h_dims == c_dims, "The dimension of Input(H0) and Input(C0) " "should be the same."); } auto wx_dims = ctx->GetInputDim("WeightX"); PADDLE_ENFORCE_EQ(wx_dims.size(), 2, "The rank of Input(WeightX) should be 2."); PADDLE_ENFORCE_EQ(wx_dims[0], x_dims[1], "The first dimension of Input(WeightX) " "should be %d.", x_dims[1]); int frame_size = wx_dims[1] / 4; auto wh_dims = ctx->GetInputDim("WeightH"); PADDLE_ENFORCE_EQ(wh_dims.size(), 2, "The rank of Input(WeightH) should be 2."); PADDLE_ENFORCE_EQ(wh_dims[0], frame_size, "The first dimension of Input(WeightH) " "should be %d.", frame_size); PADDLE_ENFORCE_EQ(wh_dims[1], 4 * frame_size, "The second dimension of Input(WeightH) " "should be 4 * %d.", frame_size); auto b_dims = ctx->GetInputDim("Bias"); PADDLE_ENFORCE_EQ(b_dims.size(), 2, "The rank of Input(Bias) should be 2."); PADDLE_ENFORCE_EQ(b_dims[0], 1, "The first dimension of Input(Bias) should be 1."); PADDLE_ENFORCE_EQ( b_dims[1], (ctx->Attrs().Get("use_peepholes") ? 7 : 4) * frame_size, "The second dimension of Input(Bias) should be " "7 * %d if enable peepholes connection or" "4 * %d if disable peepholes", frame_size, frame_size); framework::DDim out_dims({x_dims[0], frame_size}); ctx->SetOutputDim("Hidden", out_dims); ctx->SetOutputDim("Cell", out_dims); ctx->ShareLoD("X", "Hidden"); ctx->ShareLoD("X", "Cell"); int xx_width; if (ctx->Attrs().Get("use_seq")) { xx_width = wx_dims[1]; } else { xx_width = x_dims[1] > wx_dims[1] ? wx_dims[1] : x_dims[1]; PADDLE_ENFORCE(ctx->HasOutput("BatchedInput"), "Assert only one Output(BatchedInput) of LSTM."); PADDLE_ENFORCE(ctx->HasOutput("BatchedHidden"), "Assert only one Output(BatchedHidden) of LSTM."); PADDLE_ENFORCE(ctx->HasOutput("BatchedCell"), "Assert only one Output(BatchedCell) of LSTM."); PADDLE_ENFORCE(ctx->HasOutput("ReorderedH0"), "Assert only one Output(ReorderedH0) of LSTM"); PADDLE_ENFORCE(ctx->HasOutput("ReorderedC0"), "Assert only one Output(ReorderedC0) of LSTM."); ctx->SetOutputDim("BatchedInput", {x_dims[0], wx_dims[1]}); ctx->SetOutputDim("BatchedHidden", out_dims); ctx->SetOutputDim("BatchedCell", out_dims); } ctx->SetOutputDim("XX", {x_dims[0], xx_width}); ctx->ShareLoD("X", "XX"); } framework::OpKernelType FusionLSTMOp::GetExpectedKernelType( const framework::ExecutionContext& ctx) const { return framework::OpKernelType( framework::ToDataType(ctx.Input("X")->type()), ctx.device_context()); } void FusionLSTMOpMaker::Make() { AddInput("X", "(LoDTensor) the input is a LodTensor, which support " "variable-time length input sequence. The underlying tensor in " "this LoDTensor is a matrix with shape (T X M), where T is the " "total time steps in this mini-batch, M is the dim size of x."); AddInput("WeightX", "(Tensor) the learnable weights of X." " - The shape is (M x 4D), where M is the dim size of x, D is the " "hidden size. " " - Weight = {W_cx, W_ix, W_fx, W_ox}"); AddInput("WeightH", "(Tensor) same as LSTMOp, the learnable hidden-hidden weights." " - The shape is (D x 4D), where D is the hidden size. " " - Weight = {W_ch, W_ih, W_fh, W_oh}"); AddInput("Bias", "(Tensor) the learnable weights. Almost same as LSTMOp" "Note: we should add the fc bias into this (1x4D) in bias." "input-hidden bias weight and peephole connections weight if " "setting `use_peepholes` True. " "1. `use_peepholes = False` " " - The shape is (1 x 4D). " " - Bias = {b_c, b_i, b_f, b_o}." "2. `use_peepholes = True` " " - The shape is (1 x 7D). " " - Bias = {b_c, b_i, b_f, b_o, W_ic, W_fc, W_oc}."); AddInput("H0", "(Tensor, optional) (same as LSTMOp) the initial hidden state is an " "optional " "input. This is a tensor with shape (N x D), where N is the " "batch size and D is the hidden size.") .AsDispensable(); AddInput("C0", "(Tensor, optional) (same as LSTMOp) (the initial cell state is an " "optional " "input. This is a tensor with shape (N x D), where N is the " "batch size. `H0` and `C0` can be NULL but only at the same time.") .AsDispensable(); AddOutput("Hidden", "(LoDTensor) (same as LSTMOp) the hidden state of LSTM operator. " "The shape is (T x D), and lod is the same with the `Input`."); AddOutput("Cell", "(LoDTensor) (same as LSTMOp) the cell state of LSTM operator. " "The shape is (T x D), and lod is the same with the `Input`."); AddOutput("XX", "(LoDTensor) the result after X * WeightX (size is T x 4D)" " or batched_X (size is T x M), this will be automatically chosen," " where T is the total time steps in this mini-batch," " D is the hidden size, M is the dim size of x input.") .AsIntermediate(); AddOutput("BatchedInput", "(LoDTensor) (T x 4D).").AsIntermediate(); AddOutput("BatchedHidden", "(LoDTensor) (T x D).").AsIntermediate(); AddOutput("BatchedCell", "(LoDTensor) (T x D).").AsIntermediate(); AddOutput("ReorderedH0", "(LoDTensor) (N x D).").AsIntermediate(); AddOutput("ReorderedC0", "(LoDTensor) (N x D).").AsIntermediate(); AddAttr("use_peepholes", "(bool, defalut: True) " "whether to enable diagonal/peephole connections.") .SetDefault(true); AddAttr("is_reverse", "(bool, defalut: False) " "whether to compute reversed LSTM.") .SetDefault(false); AddAttr("use_seq", "(bool, defalut: True) " "whether to use seq mode to compute.") .SetDefault(true); AddAttr("gate_activation", "(string, default: sigmoid)" "The activation for input gate, forget gate and output " "gate, `sigmoid` by default.") .SetDefault("sigmoid") .InEnum({"sigmoid", "tanh", "relu", "identity"}); AddAttr("cell_activation", "(string, default: tanh)" "The activation for cell output, `tanh` by defalut.") .SetDefault("tanh") .InEnum({"sigmoid", "tanh", "relu", "identity"}); AddAttr("candidate_activation", "(string, default: tanh)" "The activation for candidate hidden state, " "`tanh` by default.") .SetDefault("tanh") .InEnum({"sigmoid", "tanh", "relu", "identity"}); AddComment(R"DOC( Fusion Long-Short Term Memory (LSTM) Operator. This operator fuse the X into LSTM, more details can refer to LSTM op. )DOC"); } template class FuisonLSTMKernel : public framework::OpKernel { public: #define INIT_VEC_FUNC \ std::function act_gate, act_cell, act_cand; \ auto& act_gate_str = ctx.Attr("gate_activation"); \ auto& act_cell_str = ctx.Attr("cell_activation"); \ auto& act_cand_str = ctx.Attr("candidate_activation"); \ if (platform::jit::MayIUse(platform::jit::avx)) { \ math::VecActivations act_functor; \ act_gate = act_functor(act_gate_str); \ act_cell = act_functor(act_cell_str); \ act_cand = act_functor(act_cand_str); \ } else { \ math::VecActivations act_functor; \ act_gate = act_functor(act_gate_str); \ act_cell = act_functor(act_cell_str); \ act_cand = act_functor(act_cand_str); \ } #define INIT_BASE_INPUT_OUTPUT \ auto* x = ctx.Input("X"); \ auto* h0 = ctx.Input("H0"); \ auto* c0 = ctx.Input("C0"); \ auto* wx = ctx.Input("WeightX"); \ auto* wh = ctx.Input("WeightH"); \ auto* bias = ctx.Input("Bias"); \ auto* xx = ctx.Output("XX"); \ auto* hidden_out = ctx.Output("Hidden"); \ auto* cell_out = ctx.Output("Cell"); \ bool is_reverse = ctx.Attr("is_reverse"); \ bool use_peepholes = ctx.Attr("use_peepholes"); #define INIT_BASE_SIZES \ auto x_dims = x->dims(); /* T x M*/ \ auto wh_dims = wh->dims(); /* D x 4D*/ \ const int M = x_dims[1]; \ const int D = wh_dims[0]; \ const int D2 = D * 2; \ const int D3 = D * 3; \ const int D4 = wh_dims[1]; #define INIT_BASE_INPUT_DATAS \ const T* x_data = x->data(); \ const T* wx_data = wx->data(); \ const T* wh_data = wh->data(); \ /* diagonal weight*/ \ const T* wc_data = bias->data() + D4; \ /* for peephole only*/ \ Tensor checked_cell; \ T* checked_cell_data = nullptr; \ auto place = ctx.GetPlace(); \ if (use_peepholes) { \ /* w_ic * Ct-1, w_fc * Ct-1 ; w_oc * Ct => ih*/ \ checked_cell_data = checked_cell.mutable_data({2, D}, place); \ } /// Compute LSTM #define GEMM_WH_ADDON(bs, prev, out) \ blas.GEMM(CblasNoTrans, CblasNoTrans, bs, D4, D, static_cast(1), prev, D, \ wh_data, D4, static_cast(1), out, D4) #define GET_Ct(ct_1, gates, ct) \ /* C_t = C_t-1 * fgated + cand_gated * igated*/ \ act_cand(D, gates, gates); \ blas.VMUL(D, gates, gates + D, gates + D); \ blas.VMUL(D, ct_1, gates + D2, gates + D2); \ blas.VADD(D, gates + D, gates + D2, ct) #define GET_Ht(ct, gates, ht) \ /* H_t = act_cell(C_t) * ogated */ \ act_cell(D, ct, gates + D2); \ blas.VMUL(D, gates + D2, gates + D3, ht) #define GET_Ct_NOH0C0(gates, ct) \ /* C_t = igated * cgated*/ \ act_gate(D, gates + D, gates + D); \ act_cand(D, gates, gates); \ blas.VMUL(D, gates, gates + D, ct) #define COMPUTE_CtHt_NOH0C0(gates, ct, ht) \ GET_Ct_NOH0C0(gates, ct); \ act_gate(D, gates + D3, gates + D3); \ GET_Ht(ct, gates, ht) #define COMPUTE_CtHt_PEEPHOLE_NOH0C0(gates, ct, ht) \ GET_Ct_NOH0C0(gates, ct); \ /* get outgated, put W_oc * C_t on igated */ \ blas.VMUL(D, wc_data + D2, ct, gates + D); \ blas.VADD(D, gates + D, gates + D3, gates + D3); \ act_gate(D, gates + D3, gates + D3); \ GET_Ht(ct, gates, ht) #define COMPUTE_CtHt(gates, ct_1, ct, ht) \ act_gate(D3, gates + D, gates + D); \ GET_Ct(ct_1, gates, ct); \ GET_Ht(ct, gates, ht) #define COMPUTE_CtHt_PEEPHOLE(gates, ct_1, ct, ht) \ /* get fgated and igated*/ \ blas.VMUL(D, wc_data, ct_1, checked_cell_data); \ blas.VMUL(D, wc_data + D, ct_1, checked_cell_data + D); \ blas.VADD(D2, checked_cell_data, gates + D, gates + D); \ act_gate(D2, gates + D, gates + D); \ GET_Ct(ct_1, gates, ct); \ /* get ogated*/ \ blas.VMUL(D, wc_data + D2, ct, gates + D); \ blas.VADD(D, gates + D, gates + D3, gates + D3); \ act_gate(D, gates + D3, gates + D3); \ GET_Ht(ct, gates, ht) void SeqCompute(const framework::ExecutionContext& ctx) const { using DeviceContext = paddle::platform::CPUDeviceContext; INIT_BASE_INPUT_OUTPUT INIT_BASE_SIZES INIT_VEC_FUNC INIT_BASE_INPUT_DATAS auto x_lod = x->lod(); const int total_T = x_dims[0]; const int N = x_lod[0].size() - 1; const T* h0_data = h0 ? h0->data() : nullptr; const T* c0_data = c0 ? c0->data() : nullptr; T* xx_data = xx->mutable_data(place); T* h_out_data = hidden_out->mutable_data(place); T* c_out_data = cell_out->mutable_data(place); auto blas = math::GetBlas(ctx); math::FCCompute(blas, total_T, D4, M, x_data, wx_data, xx_data, bias->data()); int xx_offset = D4; int gate_offset = D; if (is_reverse) { const int offset = (total_T - 1) * D; xx_data = xx_data + offset * 4; h_out_data = h_out_data + offset; c_out_data = c_out_data + offset; xx_offset = -D4; gate_offset = -D; } #define MOVE_ONE_STEP \ prev_h_data = h_out_data; \ prev_c_data = c_out_data; \ xx_data = xx_data + xx_offset; \ h_out_data = h_out_data + gate_offset; \ c_out_data = c_out_data + gate_offset #define PROCESS_H0C0_DEFINES \ int bid = is_reverse ? N - 1 - i : i; \ int seq_len = x_lod[0][bid + 1] - x_lod[0][bid]; \ const T* prev_c_data = nullptr; \ const T* prev_h_data = nullptr; \ int tstart = 0 #define PROCESS_H0C0_PEEPHOLE \ PROCESS_H0C0_DEFINES; \ if (h0_data) { \ prev_h_data = h0_data + bid * D; \ prev_c_data = c0_data + bid * D; \ } else { \ COMPUTE_CtHt_PEEPHOLE_NOH0C0(xx_data, c_out_data, h_out_data); \ MOVE_ONE_STEP; \ tstart = 1; \ } #define PROCESS_H0C0 \ PROCESS_H0C0_DEFINES; \ if (h0_data) { \ prev_h_data = h0_data + bid * D; \ prev_c_data = c0_data + bid * D; \ } else { \ COMPUTE_CtHt_NOH0C0(xx_data, c_out_data, h_out_data); \ MOVE_ONE_STEP; \ tstart = 1; \ } if (use_peepholes) { for (int i = 0; i < N; ++i) { PROCESS_H0C0_PEEPHOLE for (int step = tstart; step < seq_len; ++step) { GEMM_WH_ADDON(1, prev_h_data, xx_data); COMPUTE_CtHt_PEEPHOLE(xx_data, prev_c_data, c_out_data, h_out_data); MOVE_ONE_STEP; } } } else { // TODO(TJ): unly workaround, clean me std::function compute_ctht; if (platform::jit::MayIUse(platform::jit::avx) && act_gate_str == "sigmoid" && act_cand_str == "tanh" && act_cell_str == "tanh" && D == 8) { compute_ctht = math::lstm_compute_ctht; } else { compute_ctht = [&](T* gates, const T* ct_1, T* ct, T* ht) { COMPUTE_CtHt(gates, ct_1, ct, ht); }; } for (int i = 0; i < N; ++i) { PROCESS_H0C0 for (int step = tstart; step < seq_len; ++step) { GEMM_WH_ADDON(1, prev_h_data, xx_data); compute_ctht(xx_data, prev_c_data, c_out_data, h_out_data); MOVE_ONE_STEP; } } } #undef PROCESS_H0C0_DEFINES #undef PROCESS_H0C0_PEEPHOLE #undef PROCESS_H0C0 #undef MOVE_ONE_STEP } void BatchCompute(const framework::ExecutionContext& ctx) const { using DeviceContext = platform::CPUDeviceContext; INIT_BASE_INPUT_OUTPUT if (x->lod()[0].size() == 2) { SeqCompute(ctx); return; } INIT_BASE_SIZES INIT_VEC_FUNC INIT_BASE_INPUT_DATAS auto* reordered_h0 = ctx.Output("ReorderedH0"); auto* reordered_c0 = ctx.Output("ReorderedC0"); auto* batched_input = ctx.Output("BatchedInput"); auto* batched_c_out = ctx.Output("BatchedCell"); auto* batched_h_out = ctx.Output("BatchedHidden"); T* xx_data = xx->mutable_data(place); T* batched_input_data = batched_input->mutable_data(place); T* batched_c_out_data = batched_c_out->mutable_data(place); T* batched_h_out_data = batched_h_out->mutable_data(place); hidden_out->mutable_data(place); cell_out->mutable_data(place); math::LoDTensor2BatchFunctor to_batch; auto& dev_ctx = ctx.template device_context(); auto blas = math::GetBlas(dev_ctx); if (M > D4) { math::FCCompute(blas, x_dims[0], D4, M, x_data, wx_data, xx_data, bias->data()); to_batch(dev_ctx, *xx, batched_input, true, is_reverse); } else { to_batch(dev_ctx, *x, xx, true, is_reverse); batched_input->set_lod(xx->lod()); math::FCCompute(blas, x_dims[0], D4, M, xx_data, wx_data, batched_input_data, bias->data()); } auto batched_lod = batched_input->lod(); const auto& seq_order = batched_lod[2]; const int max_bs = seq_order.size(); reordered_h0->Resize({max_bs, D}); reordered_c0->Resize({max_bs, D}); int tstart = 0; T* prev_h_data = nullptr; T* prev_c_data = nullptr; if (h0) { // reorder h0, c0 T* reordered_h0_data = reordered_h0->mutable_data(place); T* reordered_c0_data = reordered_c0->mutable_data(place); const T* h0_data = h0->data(); const T* c0_data = c0->data(); prev_h_data = reordered_h0_data; prev_c_data = reordered_c0_data; size_t sz = sizeof(T) * D; for (int i = 0; i < max_bs; ++i) { std::memcpy(reordered_h0_data, h0_data + seq_order[i] * D, sz); std::memcpy(reordered_c0_data, c0_data + seq_order[i] * D, sz); reordered_h0_data += D; reordered_c0_data += D; } } else { // compute without h0, c0 T* cur_in_data = batched_input_data; T* cur_h_out_data = batched_h_out_data; T* cur_c_out_data = batched_c_out_data; for (int i = 0; i < max_bs; ++i) { GET_Ct_NOH0C0(cur_in_data, cur_c_out_data); if (use_peepholes) { blas.VMUL(D, wc_data + D2, cur_c_out_data, cur_in_data + D); blas.VADD(D, cur_in_data + D, cur_in_data + D3, cur_in_data + D3); } act_gate(D, cur_in_data + D3, cur_in_data + D3); GET_Ht(cur_c_out_data, cur_in_data, cur_h_out_data); cur_in_data += D4; cur_c_out_data += D; cur_h_out_data += D; } tstart = 1; prev_h_data = batched_h_out_data; prev_c_data = batched_c_out_data; } const auto& batch_starts = batched_lod[0]; const int max_seq_len = batch_starts.size() - 1; const int offset = tstart * max_bs * D; batched_input_data = batched_input_data + offset * 4; batched_h_out_data = batched_h_out_data + offset; batched_c_out_data = batched_c_out_data + offset; #define DEFINE_CUR \ T* cur_in_data = batched_input_data; \ T* cur_prev_c_data = prev_c_data; \ T* cur_c_out_data = batched_c_out_data; \ T* cur_h_out_data = batched_h_out_data #define MOVE_ONE_BATCH \ cur_in_data += D4; \ cur_prev_c_data += D; \ cur_c_out_data += D; \ cur_h_out_data += D #define MOVE_ONE_STEP \ prev_c_data = batched_c_out_data; \ prev_h_data = batched_h_out_data; \ batched_c_out_data = cur_c_out_data; \ batched_h_out_data = cur_h_out_data; \ batched_input_data = cur_in_data if (use_peepholes) { for (int step = tstart; step < max_seq_len; ++step) { const int cur_bs = batch_starts[step + 1] - batch_starts[step]; GEMM_WH_ADDON(cur_bs, prev_h_data, batched_input_data); DEFINE_CUR; for (int i = 0; i < cur_bs; ++i) { COMPUTE_CtHt_PEEPHOLE(cur_in_data, cur_prev_c_data, cur_c_out_data, cur_h_out_data); MOVE_ONE_BATCH; } MOVE_ONE_STEP; } } else { for (int step = tstart; step < max_seq_len; ++step) { const int cur_bs = batch_starts[step + 1] - batch_starts[step]; GEMM_WH_ADDON(cur_bs, prev_h_data, batched_input_data); DEFINE_CUR; for (int i = 0; i < cur_bs; ++i) { COMPUTE_CtHt(cur_in_data, cur_prev_c_data, cur_c_out_data, cur_h_out_data); MOVE_ONE_BATCH; } MOVE_ONE_STEP; } } #undef MOVE_ONE_STEP #undef MOVE_ONE_BATCH #undef DEFINE_CUR math::Batch2LoDTensorFunctor to_seq; batched_h_out->set_lod(batched_lod); to_seq(dev_ctx, *batched_h_out, hidden_out); batched_c_out->set_lod(batched_lod); to_seq(dev_ctx, *batched_c_out, cell_out); } void Compute(const framework::ExecutionContext& ctx) const override { if (ctx.Attr("use_seq")) { SeqCompute(ctx); } else { BatchCompute(ctx); } } #undef COMPUTE_CtHt_PEEPHOLE #undef COMPUTE_CtHt #undef GET_Ct_NOH0C0 #undef COMPUTE_CtHt_NOH0C0 #undef COMPUTE_CtHt_PEEPHOLE_NOH0C0 #undef GET_Ht #undef GET_Ct #undef GEMM_WH_ADDON #undef INIT_BASE_INPUT_DATAS #undef INIT_BASE_SIZES #undef INIT_BASE_INPUT_OUTPUT #undef INIT_VEC_FUNC }; } // namespace operators } // namespace paddle namespace ops = paddle::operators; REGISTER_OPERATOR(fusion_lstm, ops::FusionLSTMOp, ops::FusionLSTMOpMaker, paddle::framework::DefaultGradOpDescMaker); REGISTER_OP_CPU_KERNEL(fusion_lstm, ops::FuisonLSTMKernel, ops::FuisonLSTMKernel);