Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
兽拳
Paddle
提交
5a15c70e
P
Paddle
项目概览
兽拳
/
Paddle
与 Fork 源项目一致
Fork自
PaddlePaddle / Paddle
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
P
Paddle
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1
Issue
1
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
5a15c70e
编写于
1月 18, 2017
作者:
Y
Yu Yang
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Make Error interface cleaner
上级
699d18f1
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
45 addition
and
73 deletion
+45
-73
paddle/gserver/activations/ActivationFunction.cpp
paddle/gserver/activations/ActivationFunction.cpp
+3
-3
paddle/utils/Error.h
paddle/utils/Error.h
+32
-60
paddle/utils/tests/test_Error.cpp
paddle/utils/tests/test_Error.cpp
+10
-10
未找到文件。
paddle/gserver/activations/ActivationFunction.cpp
浏览文件 @
5a15c70e
...
...
@@ -169,7 +169,7 @@ Argument argument_;
public:
Error
__must_check
forward
(
Argument
&
act
)
{
if
(
act
.
value
->
getWidth
()
!=
1UL
)
{
return
Error
F
(
return
Error
(
"Input width for each timestep of sequence softmax should be 1"
);
}
...
...
@@ -193,7 +193,7 @@ Error __must_check forward(Argument& act) {
Error
__must_check
backward
(
Argument
&
act
)
{
if
(
act
.
value
->
getWidth
()
!=
1UL
)
{
return
Error
F
(
return
Error
(
"Input width for each timestep of sequence softmax should be 1"
);
}
...
...
@@ -208,7 +208,7 @@ Error __must_check backward(Argument& act) {
argument_
.
grad
->
setData
(
act
.
grad
->
getData
()
+
offset
,
1UL
,
size
);
Error
status
=
softmax_
.
backward
(
argument_
);
if
(
!
status
.
isOK
()
)
return
status
;
if
(
!
status
)
return
status
;
}
return
Error
();
}
...
...
paddle/utils/Error.h
浏览文件 @
5a15c70e
...
...
@@ -23,14 +23,12 @@ limitations under the License. */
namespace
paddle
{
/**
* Status is Paddle error code. It only contain a std::string as error message.
* Although Status inherits the std::exception, but do not throw it except you
* know what you are doing.
* Error is Paddle error code. It only contain a std::string as error message.
*
*
* There are two styles to return
status
in Paddle.
* There are two styles to return
error
in Paddle.
*
* 1. Return
Status
* 1. Return
Error
* When method return a status, the return must use `__must_check` attribute.
* Example as below.
* @code{cpp}
...
...
@@ -39,29 +37,29 @@ namespace paddle {
* Error __must_check bar() {
* // do something.
* Status s = foo(); // invoke other method return status.
* if (!s
.isOK()
) return s;
* if (!s) return s;
* // do something else.
* return Status();
* }
* @endcode{cpp}
*
* 2. Return by parameter.
* It is another way to return a
status
, by using a pointer parameter.
* It is another way to return a
n error
, by using a pointer parameter.
* Example as below.
*
* @code{cpp}
* Error bar();
*
* int foo(Error*
status
) {
* int foo(Error*
error
) {
* // Do something.
*
Status
s = bar();
* if (!s
.isOK()
) {
* *
status
= s;
*
Error
s = bar();
* if (!s) {
* *
error
= s;
* return 0;
* }
* // Do something else.
* if (someInternalErrorHappend) {
* *
status = ErrorF
("Some dimension is too large, %d", dimension);
* *
error = Error
("Some dimension is too large, %d", dimension);
* return 0;
* }
* // End of method.
...
...
@@ -72,7 +70,7 @@ namespace paddle {
* Error s;
* // do something.
* foo(&s);
* if (!s
.isOK()
) return s;
* if (!s) return s;
* }
* @endcode{cpp}
*
...
...
@@ -81,17 +79,31 @@ namespace paddle {
* use log(FATAL) or CHECK to make program exit before. When we clean all
* log(FATAL) and CHECK in Paddle, 'check' method will be removed.
*/
class
Error
final
:
public
std
::
exception
{
class
Error
final
{
public:
/**
* Default Status. OK
*/
Error
()
noexcept
{}
inline
Error
()
{}
/**
* @brief
what will return the error message. If status is OK, return nullptr
.
* @brief
Create an Error use printf syntax
.
*/
const
char
*
what
()
const
noexcept
override
{
inline
explicit
Error
(
const
char
*
fmt
,
...)
{
va_list
ap
;
va_start
(
ap
,
fmt
);
constexpr
size_t
kBufferSize
=
1024
;
this
->
errMsg_
.
reset
(
new
std
::
string
(
kBufferSize
,
0
));
auto
sz
=
vsnprintf
(
&
(
*
errMsg_
)[
0
],
kBufferSize
,
fmt
,
ap
);
this
->
errMsg_
->
resize
(
sz
);
this
->
errMsg_
->
shrink_to_fit
();
va_end
(
ap
);
}
/**
* @brief what will return the error message. If no error, return nullptr.
*/
inline
const
char
*
msg
()
const
{
if
(
errMsg_
)
{
return
errMsg_
->
data
();
}
else
{
...
...
@@ -100,58 +112,18 @@ public:
}
/**
* @brief isOK
* @return true if OK.
* @brief operator bool, return True if there is no error.
*/
inline
bool
isOK
()
const
noexcept
{
return
errMsg_
==
nullptr
;
}
inline
operator
bool
()
const
{
return
!
errMsg_
;
}
/**
* @brief check this status by glog.
* @note It is a temp method used during cleaning Paddle code. It will be
* removed later.
*/
inline
void
check
()
const
{
CHECK
(
isOK
())
<<
what
();
}
/**
* friend method to create Error.
*/
template
<
typename
...
ARGS
>
friend
Error
__must_check
ErrorF
(
const
char
*
fmt
,
ARGS
...
args
);
inline
void
check
()
const
{
CHECK
(
*
this
)
<<
msg
();
}
private:
std
::
shared_ptr
<
std
::
string
>
errMsg_
;
};
/**
* ErrorF will create an Error by printf syntax.
*
* Specialize this method because clang will give a warning when use printf(fmt)
* without arguments.
*/
template
<
>
inline
Error
__must_check
ErrorF
(
const
char
*
msg
)
{
Error
e
;
e
.
errMsg_
.
reset
(
new
std
::
string
(
msg
));
return
e
;
}
/**
* ErrorF will create an Error by printf syntax.
*
* Examples:
* @code{cpp}
* auto err = ErrorF("SomeError");
* auto err2 = ErrorF("SomeErrorWithParameter %f %d", real_val, int_val);
* @endcode{cpp}
*/
template
<
typename
...
ARGS
>
inline
Error
__must_check
ErrorF
(
const
char
*
fmt
,
ARGS
...
args
)
{
constexpr
size_t
kBufferSize
=
1024
;
char
buffer
[
kBufferSize
];
snprintf
(
buffer
,
kBufferSize
,
fmt
,
args
...);
Error
e
;
e
.
errMsg_
.
reset
(
new
std
::
string
(
buffer
));
return
e
;
}
}
// namespace paddle
paddle/utils/tests/test_Error.cpp
浏览文件 @
5a15c70e
...
...
@@ -18,17 +18,17 @@ limitations under the License. */
TEST
(
Error
,
testAll
)
{
paddle
::
Error
error
;
ASSERT_TRUE
(
error
.
isOK
()
);
error
=
paddle
::
Error
F
(
"I'm the error"
);
ASSERT_FALSE
(
error
.
isOK
()
);
ASSERT_STREQ
(
"I'm the error"
,
error
.
what
());
ASSERT_TRUE
(
error
);
error
=
paddle
::
Error
(
"I'm the error"
);
ASSERT_FALSE
(
error
);
ASSERT_STREQ
(
"I'm the error"
,
error
.
msg
());
error
=
paddle
::
Error
F
(
"error2"
);
ASSERT_FALSE
(
error
.
isOK
()
);
ASSERT_STREQ
(
"error2"
,
error
.
what
());
error
=
paddle
::
Error
(
"error2"
);
ASSERT_FALSE
(
error
);
ASSERT_STREQ
(
"error2"
,
error
.
msg
());
int
i
=
3
;
auto
error3
=
paddle
::
Error
F
(
"error%d"
,
i
);
ASSERT_FALSE
(
error3
.
isOK
()
);
ASSERT_STREQ
(
"error3"
,
error3
.
what
());
auto
error3
=
paddle
::
Error
(
"error%d"
,
i
);
ASSERT_FALSE
(
error3
);
ASSERT_STREQ
(
"error3"
,
error3
.
msg
());
}
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录