Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added softplus FP32 FWD OneDNN kernel #36382

Merged
merged 8 commits into from
Oct 18, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions paddle/fluid/operators/mkldnn/activation_mkldnn_op.cc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
limitations under the License. */

#include "paddle/fluid/operators/activation_op.h"
#include "paddle/fluid/operators/mkldnn/softplus_mkldnn_op.h"
#include "paddle/fluid/platform/mkldnn_reuse.h"

namespace paddle {
Expand Down Expand Up @@ -169,6 +170,13 @@ struct GeluMKLDNNGradFunctor : public BaseActivationFunctor<T> {
}
};

template <typename T>
struct SoftplusMKLDNNFunctor : public BaseActivationFunctor<T> {
void operator()(const framework::ExecutionContext &ctx) const {
custom_softplus_eltwise_forward<T>(ctx);
}
};

template <typename T>
using ReluMKLDNNFunctor =
MKLDNNActivationFunc<T, mkldnn::algorithm::eltwise_relu>;
Expand Down Expand Up @@ -272,3 +280,8 @@ REGISTER_ACTIVATION_MKLDNN_BF16_KERNEL(gelu, GeluMKLDNNFunctor,
GeluMKLDNNGradFunctor);
REGISTER_ACTIVATION_MKLDNN_BF16_KERNEL(sigmoid, SigmoidMKLDNNFunctor,
SigmoidMKLDNNGradFunctor);

namespace ops = paddle::operators;
REGISTER_OP_KERNEL(
softplus, MKLDNN, paddle::platform::CPUPlace,
ops::MKLDNNActivationKernel<ops::SoftplusMKLDNNFunctor<float>>);
94 changes: 94 additions & 0 deletions paddle/fluid/operators/mkldnn/softplus_mkldnn_op.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/* Copyright (c) 2021 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/platform/mkldnn_reuse.h"

namespace paddle {
namespace operators {

using paddle::framework::Tensor;

template <typename T>
class SoftplusMKLDNNHandler
: public platform::MKLDNNHandlerNoCachingT<T, dnnl::binary> {
public:
SoftplusMKLDNNHandler(const Tensor* x, const float beta,
const mkldnn::engine engine, platform::Place cpu_place)
: platform::MKLDNNHandlerNoCachingT<T, dnnl::binary>(engine, cpu_place) {
auto x_tz = framework::vectorize(x->dims());
auto x_md =
dnnl::memory::desc(x_tz, platform::MKLDNNGetDataType<T>(), x->format());

auto beta_tz = std::vector<int64_t>(x_tz.size(), 1);
auto beta_md = dnnl::memory::desc(beta_tz, platform::MKLDNNGetDataType<T>(),
x->format());

dnnl::post_ops post_ops;
post_ops.append_eltwise(1.0f, dnnl::algorithm::eltwise_soft_relu, 0.0f,
0.0f);
if (beta != 1.0f) {
post_ops.append_eltwise(1.0f, dnnl::algorithm::eltwise_linear,
1.0f / beta, 0.0f);
}

dnnl::primitive_attr attrs;
attrs.set_post_ops(post_ops);

this->AcquireForwardPrimitiveDescriptor(attrs, dnnl::algorithm::binary_mul,
x_md, beta_md, x_md);
Comment on lines +37 to +49
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like this would allow to skip the multiplication by 1 if beta = 1, this exact code probably won't work but I hope you understand what I mean. I'm not sure if it's worth putting in the extra work though (it depends how often beta is equal to 1 in practice).

Suggested change
dnnl::post_ops post_ops;
post_ops.append_eltwise(1.0f, dnnl::algorithm::eltwise_soft_relu, 0.0f,
0.0f);
if (beta != 1.0f) {
post_ops.append_eltwise(1.0f, dnnl::algorithm::eltwise_linear,
1.0f / beta, 0.0f);
}
dnnl::primitive_attr attrs;
attrs.set_post_ops(post_ops);
this->AcquireForwardPrimitiveDescriptor(attrs, dnnl::algorithm::binary_mul,
x_md, beta_md, x_md);
if (beta == 1.0f)
{
this->AcquireForwardPrimitiveDescriptor(attrs, dnnl::algorithm::eltwise_soft_relu, x_md, x_md);
}
else
{
dnnl::post_ops post_ops;
post_ops.append_eltwise(1.0f, dnnl::algorithm::eltwise_soft_relu, 0.0f,
0.0f);
post_ops.append_eltwise(1.0f, dnnl::algorithm::eltwise_linear,
1.0f / beta, 0.0f);
dnnl::primitive_attr attrs;
attrs.set_post_ops(post_ops);
this->AcquireForwardPrimitiveDescriptor(attrs, dnnl::algorithm::binary_mul,
x_md, beta_md, x_md);
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was done like that in the previous commits of this PR, but I have agreed with Jacek, that the overall change in performance was meaningless, and this way the code is unified and much more clear. Moreover, this operator will be fused with tanh activation(for ppyolov2_r50vd_365e model), so in that case binary operation must be done, because eltwise primitive does not support fusing with another eltwise primitive. But you've definitely got a point that execution time would be faster if there would be just soft_relu without binary_mul at the beginning

}

std::shared_ptr<mkldnn::memory> AcquireBetaMemory(const float* beta) {
return this->AcquireMemoryFromPrimitive(
this->fwd_pd_->src1_desc(), platform::to_void_cast<float>(beta));
}
};

template <typename T>
void custom_softplus_eltwise_forward(const framework::ExecutionContext& ctx) {
const auto& dev_ctx =
ctx.template device_context<platform::MKLDNNDeviceContext>();
const auto& mkldnn_engine = dev_ctx.GetEngine();

const auto* x = ctx.Input<Tensor>("X");
auto* out = ctx.Output<Tensor>("Out");

bool is_inplaced = x->IsSharedBufferWith(*out);

const float beta = ctx.Attr<float>("beta");

SoftplusMKLDNNHandler<T> handler(x, beta, mkldnn_engine, ctx.GetPlace());

auto src_memory_p = handler.AcquireSrcMemory(x);

auto beta_memory_p = handler.AcquireBetaMemory(&beta);
auto dst_memory_p =
is_inplaced ? src_memory_p : handler.AcquireDstMemory(out);
auto binary_p = handler.AcquireForwardPrimitive();

auto& astream = paddle::platform::MKLDNNDeviceContext::tls().get_stream();

const std::unordered_map<int, dnnl::memory> args = {
{DNNL_ARG_SRC_0, *src_memory_p},
{DNNL_ARG_SRC_1, *beta_memory_p},
{DNNL_ARG_DST, *dst_memory_p}};

binary_p->execute(astream, args);
astream.wait();

out->set_layout(framework::DataLayout::kMKLDNN);
out->set_format(platform::GetMKLDNNFormat(*dst_memory_p));
}
} // namespace operators
} // namespace paddle
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Copyright (c) 2021 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.

from __future__ import print_function

import unittest
import numpy as np
from paddle.fluid.tests.unittests.op_test import OpTest, OpTestTool
import paddle
import paddle.fluid as fluid
import paddle.fluid.core as core
from paddle.fluid.framework import _current_expected_place


def ref_softplus(x, beta, threshold):
x_beta = beta * x
out = np.select([x_beta <= threshold, x_beta > threshold],
[np.log(1 + np.exp(x_beta)) / beta, x])
return out


@OpTestTool.skip_if(not (isinstance(_current_expected_place(), core.CPUPlace)),
"GPU is not supported")
class TestSoftplusOneDNNOp(OpTest):
def setUp(self):
self.op_type = "softplus"
self.beta = 1
self.threshold = 20
self.config()
self.attrs = {'use_mkldnn': True, 'beta': self.beta}
self.inputs = {'X': np.random.random(self.x_shape).astype(np.float32)}
self.outputs = {
'Out': ref_softplus(self.inputs['X'], self.beta, self.threshold)
}

def config(self):
self.x_shape = (10, 10)

def test_check_output(self):
self.check_output()


class TestSoftplus4DOneDNNOp(TestSoftplusOneDNNOp):
def config(self):
self.x_shape = (10, 5, 4, 2)


class TestSoftplus6DOneDNNOp(TestSoftplusOneDNNOp):
def config(self):
self.x_shape = (3, 2, 2, 5, 4, 2)


class TestSoftplus6DExtendedFunctorOneDNNOp(TestSoftplusOneDNNOp):
def config(self):
self.x_shape = (3, 5, 2, 5, 4, 2)
self.beta = 2.5


class TestSoftplus3DExtendedFunctorOneDNNOp(TestSoftplusOneDNNOp):
def config(self):
self.x_shape = (20, 4, 2)
self.beta = 0.4


if __name__ == "__main__":
paddle.enable_static()
unittest.main()