[Custom OP]add PD_THROW and PD_CHECK for User Error message #31253

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.

Sign up for GitHub

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

Jump to bottom

Merged

chenwhql merged 7 commits into PaddlePaddle:develop from zhwesky2010:custom_op_exception

Feb 27, 2021

Contributor

zhwesky2010 commented Feb 26, 2021 •

edited

Loading

PR types

New features

PR changes

OPs

Describe

用户在自定义OP中使用宏 `PD_CHECK` 、 `PD_THROW`添加报错信息，支持变长参数模板

1. PD_THROW()

An error occured at /zhouwei25/Paddle/python/paddle/fluid/tests/custom_op/custom_relu_op.cc:82

2. PD_THROW("PD_THROW returns ", false, ". DataType of ", 1, " is INT")

PD_THROW returns false. DataType of 1 is INT at /zhouwei25/Paddle/python/paddle/fluid/tests/custom_op/custom_relu_op.cc:82

3. PD_CHECK(a > b)

Expected a > b, but it's not satisfied at /zhouwei25/Paddle/python/paddle/fluid/tests/custom_op/custom_relu_op.cc:82

4. PD_CHECK(c < d, "PD_CHECK returns false ", because c > d")

"PD_CHECK returns false, because c > d at /zhouwei25/Paddle/python/paddle/fluid/tests/custom_op/custom_relu_op.cc:82

例如，在Windows10上：


          [Custom OP]add PD_THROW and PD_CHECK for User error message

ae098bd

paddle-bot-old bot commented Feb 26, 2021

Thanks for your contribution!
Please wait for the result of CI firstly. See Paddle CI Manual for details.

chenwhql reviewed

View reviewed changes

paddle/fluid/extension/include/op_meta_info.h Outdated

    
              #define PD_LIKELY(expr) (expr)

              #endif

              struct PD_Exception : public std::exception {

Contributor

chenwhql Feb 26, 2021

I think split Exception、CHECK、THROW to a new header file exception.h is better

Contributor Author

zhwesky2010 Feb 26, 2021 •

edited

Loading

Done, split to exception.h

paddle/fluid/extension/include/op_meta_info.h Outdated

    
                  if (PD_UNLIKELY(!(COND))) {                                           \

                    HANDLE_THE_ERROR                                                    \

                    auto __message__ = ::paddle::ErrorMessage(__VA_ARGS__).to_string(); \

                    throw ::paddle::PD_Exception(__message__, __FILE__, __LINE__,       \

Contributor

chenwhql Feb 26, 2021

这个file和line的格式能再整理一下吗，现在回导致第一行信息太长，是不是换行之后缩进一下，用括号包起来，比如

ExternalError: error message.
  [file:line]

Contributor Author

zhwesky2010 Feb 26, 2021

Done

paddle/fluid/extension/include/op_meta_info.h Outdated

    
                    HANDLE_THE_ERROR                                                    \

                    auto __message__ = ::paddle::ErrorMessage(__VA_ARGS__).to_string(); \

                    throw ::paddle::PD_Exception(__message__, __FILE__, __LINE__,       \

                                                 "Expected " #COND                      \

Contributor

chenwhql Feb 26, 2021

这两个提升我觉得可以没有，因为这个是给用户用的，他自己清楚自己写了什么报错，加了多余的信息，他反而会觉得疑惑
框架里面有，主要是为了方便外部用户反馈过来的时候，我们RD能够比较快找到报错语句

Contributor Author

zhwesky2010 Feb 26, 2021

默认的报错信息，用户如果写了就以用户为准

Aurelius84 reviewed

View reviewed changes

paddle/fluid/extension/include/dispatch.h Outdated

    
                                               " not implemented for data type `" +  \

                                               ::paddle::ToString(__dtype__) + "`"); \

                      PD_THROW("function " #NAME " not implemented for data type `", \

                               ::paddle::ToString(__dtype__), "`");                  \

Contributor

Aurelius84 Feb 26, 2021

Grammar problem：is not implemented

Contributor Author

zhwesky2010 Feb 26, 2021

Done

paddle/fluid/extension/include/dispatch.h

    
                                               " not implemented for data type `" +         \

                                               ::paddle::ToString(__dtype__) + "`");        \

                      PD_THROW("function " #NAME " not implemented for data type `" +       \

                               ::paddle::ToString(__dtype__) + "`");                        \

Contributor

Aurelius84 Feb 26, 2021

Same as above

Contributor Author

zhwesky2010 Feb 26, 2021

Done

paddle/fluid/extension/include/dispatch.h Outdated

    
                    PD_PRIVATE_CASE_TYPE(NAME, ::paddle::DataType::COMPLEX128,        \

                                         ::paddle::complex128, __VA_ARGS__)           \

                    default:                                                          \

                      PD_THROW("function " #NAME " not implemented for data type `" + \

Contributor

Aurelius84 Feb 26, 2021

Same as above

paddle/fluid/extension/include/dispatch.h Outdated

    
                      throw std::runtime_error("function " #NAME                            \

                                               " not implemented for data type `" +         \

                                               ::paddle::ToString(__dtype__) + "`");        \

                      PD_THROW("function " #NAME " not implemented for data type `" +       \

Contributor

Aurelius84 Feb 26, 2021

Same as above

Contributor Author

zhwesky2010 Feb 26, 2021

Done

paddle/fluid/extension/include/dispatch.h

    
                                               " not implemented for data type `" +         \

                                               ::paddle::ToString(__dtype__) + "`");        \

                      PD_THROW("function " #NAME " not implemented for data type `" +       \

                               ::paddle::ToString(__dtype__) + "`");                        \

Contributor

Aurelius84 Feb 26, 2021

Same as above.

Contributor Author

zhwesky2010 Feb 26, 2021

Done

zhwesky2010 added 2 commits

February 26, 2021 10:34


          PD_THROW and PD_CHECK, fix comment

a2e6f44


          Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into…

07d5956

… develop

zhwesky2010 changed the title ~~[Custom OP]add PD_THROW and PD_CHECK for User error message~~ [Custom OP]add PD_THROW and PD_CHECK for User Error message


          fix Windows error message

bc3481f

zhwesky2010 force-pushed the custom_op_exception branch from 3ce88f4 to ec9a651 Compare

February 26, 2021 13:27

paddle-bot-old bot referenced this pull request


          fix Windows error message

ec9a651


          fix Windows error message

zhwesky2010 force-pushed the custom_op_exception branch from ec9a651 to 3212435 Compare

February 26, 2021 14:52


          Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into…

07ea97e

… develop


          fix CI

f3abcde

zhwesky2010 force-pushed the custom_op_exception branch from 0724d69 to f3abcde Compare

February 27, 2021 08:24

chenwhql approved these changes

View reviewed changes

chenwhql merged commit af9066e into PaddlePaddle:develop

chenwhql pushed a commit to chenwhql/Paddle that referenced this pull request


          [Custom OP]add PD_THROW and PD_CHECK for User Error message (PaddlePa…

430dcfa

…ddle#31253)

* [Custom OP]add PD_THROW and PD_CHECK for User error message

* PD_THROW and PD_CHECK, fix comment

* fix Windows error message

* fix Windows error message

* fix CI

lanxianghit pushed a commit that referenced this pull request


          [Cherry-pick] The 4th part of new custom op (#31282)

777d1a4

* modify custom op dependent from paddle_framework to paddle_custom_op (#31195)

* [Custom Op] Remove unsupport dtypes (#31232)

* remove remove_unsupport_dtype

* remove remove_unsupport_dtype

* remove test dtype

* add more include

* change dtype.h's enum as enum class to avoid conflict with inference lib

* make enum as enum class

* remove additional test

* merge develop

* polish code

* [Custom OP] Support stream set on Custom Op (#31257)

* [Custom OP] change the user header file format, test=develop (#31274)

* [Custom OP]add PD_THROW and PD_CHECK for User Error message (#31253)

* [Custom OP]add PD_THROW and PD_CHECK for User error message

* PD_THROW and PD_CHECK, fix comment

* fix Windows error message

* fix Windows error message

* fix CI

* [Custom OP]add MSVC compile check on Windows (#31265)

* fix test_check_abi

Co-authored-by: Zhou Wei <52485244+zhouwei25@users.noreply.github.com>
Co-authored-by: Jiabin Yang <marsyang199376@gmail.com>
Co-authored-by: 石晓伟 <39303645+Shixiaowei02@users.noreply.github.com>
Co-authored-by: zhouwei25 <zhouwei25@baidu.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet