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

GeneratePass for Python Pass #35708

Merged
merged 5 commits into from
Sep 17, 2021
Merged

Conversation

Avin0323
Copy link
Contributor

@Avin0323 Avin0323 commented Sep 14, 2021

PR types

New features

PR changes

Others

Describe

PR主要功能:GeneratePass—处理Python侧子图替换类Pass规则描述,生成对应的Pass实例。

背景

#35602 提供Python侧开发子图替换类Pass的方式:

  • 利用Paddle Python API或者辅助类型定义子图program用来匹配/替换图;
  • Python侧注册Pass时,将注册函数最终转换为protobuf定义的PassDesc数据形式,供C++侧进行解析完成Pass实例注册。

本PR即为根据PassDesc规则描述解析生成Pass实例。

方案设计

Pass规则验证

在以往的Pass开发中,会存在随着算子迭代引发的匹配失效或者错误匹配的问题,该问题可以通过扫描算子支持的参数设置及参数类型等来判断是否应该使用该Pass或者给出提示需要修改Pass代码。

当前Pass开发中提供了算子兼容性OpCompatSensiblePass用于解决上述问题。但同时还存在不足:由于以往Pass开发在运行时才能获取到pattern信息,所以需要在执行Pass时才可以判断。

使用PassDesc表示的Pass可以在执行Pass前验证上述问题,这个过程在VerifyDesc中完成。

根据匹配子图构造pattern

GeneratePass对于图匹配和替换使用GraphPatternDecetor完成,构造匹配pattern实际上就是将对应对象成员PDPattern中添加PDNode和边关系。该过程在函数InitGeneratePattern中完成,该函数没有作为GeneratePass的成员方法,主要出于后续可能开发新的Decetor考虑,GeneratePass与Decetor的操作是没有关联的。

初始化pattern主要通过遍历匹配子图program的全部算子实现:

  1. 添加当前算子对应PDNode及限制条件(算子类型、属性限制等);
  2. 遍历当前算子对应输入并从pattern中尝试获取PDNode:
    • 在pattern中获取到PDNode且为输出节点:表示属于匹配子图的中间节点,将该PDNode设置为中间节点;
    • 在pattern中没有获取到PDNode:添加该输入PDNode并设置作为输入节点;
    • 设置输入到算子的边关系;
  3. 遍历当前算子对应输出:
    • 在pattern中获取到PDNode且为输入节点:表示属于匹配子图的中间节点,将该PDNode设置为中间节点;
    • 在pattern中没有获取到PDNode:添加该输入PDNode并设置作为输出节点;
    • 设置算子到输出的边关系;
根据替换子图操作graph

替换子图操作的过程在GetGenerateRewrite函数中完成,与InitGeneratePattern类似没有作为GeneratePass的成员方法。

生成替换子图操作过程如下:

  1. 判断冗余替换子图;
  2. 遍历替换子图program的全部算子添加替换子图Node:
    1. 添加当前算子的Node及属性设置;
    2. 遍历当前算子对应输入,添加中间variable节点;
    3. 遍历当前算子对应输出,添加中间variable节点;
    4. 添加输入/输出节点与算子节点的边关系;
  3. 删除匹配图中属于中间节点的Node;
优化子图验证

对于替换子图或者替换后的计算图是否可以正确运行等,可以在执行Pass时验证,从而防止在后续执行计算图时出现异常。

当前Pass执行直接修改计算图,验证失败时无法很好的完成还原操作,目前子图验证暂时默认成功,留到后续改进。

@paddle-bot-old
Copy link

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

@Avin0323 Avin0323 changed the title [WIP]GeneratePass for Python Pass GeneratePass for Python Pass Sep 15, 2021
Copy link
Member

@zhhsplendid zhhsplendid left a comment

Choose a reason for hiding this comment

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

Now unit test is ready, please try to add Python test to verify the whole generate pass can work correctly in next PRs

namespace framework {
namespace ir {

void InitGeneratePattern(PDPattern* pattern, const proto::PassDesc& pass_desc) {
Copy link
Member

Choose a reason for hiding this comment

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

Usually we put input or const parameter pass_desc in front of output or changable parameter pattern.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

PADDLE_ENFORCE_EQ(
framework::ir::PassRegistry::Instance().Has(pass_type), false,
platform::errors::AlreadyExists(
"Pass '%s' is registered more than once.", pass_type));
Copy link
Member

Choose a reason for hiding this comment

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

Add:

"Pass '%s' is registered more than once. Please use another name"

Then if users name their pass the same as Paddle pass, or find the GeneratePass has problem, they know what to change.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

namespace ir {

void InitGeneratePattern(PDPattern* pattern, const proto::PassDesc& pass_desc) {
const proto::BlockDesc& block = pass_desc.pattern().blocks(0);
Copy link
Member

Choose a reason for hiding this comment

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

If we don't support cross block pass, we should mention it in python/c++ interface or API comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Usually, a subgraph is only in one block. We can support corss block in future if necessary.
I will add descriptions in next PR.

Copy link
Member

@zhhsplendid zhhsplendid left a comment

Choose a reason for hiding this comment

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

LGTM

@zhhsplendid zhhsplendid merged commit f6db980 into PaddlePaddle:develop Sep 17, 2021
@Avin0323 Avin0323 deleted the generate-pass branch September 17, 2021 02:26
AnnaTrainingG pushed a commit to AnnaTrainingG/Paddle that referenced this pull request Sep 29, 2021
#### 背景

PaddlePaddle#35602 提供Python侧开发子图替换类Pass的方式:

- 利用Paddle Python API或者辅助类型定义子图program用来匹配/替换图;
- Python侧注册Pass时,将注册函数最终转换为protobuf定义的PassDesc数据形式,供C++侧进行解析完成Pass实例注册。

本PR即为根据PassDesc规则描述解析生成Pass实例。

#### 方案设计

##### Pass规则验证

在以往的Pass开发中,会存在随着算子迭代引发的匹配失效或者错误匹配的问题,该问题可以通过扫描算子支持的参数设置及参数类型等来判断是否应该使用该Pass或者给出提示需要修改Pass代码。

当前Pass开发中提供了算子兼容性OpCompatSensiblePass用于解决上述问题。但同时还存在不足:由于以往Pass开发在运行时才能获取到pattern信息,所以需要在执行Pass时才可以判断。

使用PassDesc表示的Pass可以在执行Pass前验证上述问题,这个过程在VerifyDesc中完成。

##### 根据匹配子图构造pattern

GeneratePass对于图匹配和替换使用GraphPatternDecetor完成,构造匹配pattern实际上就是将对应对象成员PDPattern中添加PDNode和边关系。该过程在函数`InitGeneratePattern`中完成,该函数没有作为GeneratePass的成员方法,主要出于后续可能开发新的Decetor考虑,GeneratePass与Decetor的操作是没有关联的。

初始化pattern主要通过遍历匹配子图program的全部算子实现:

1. 添加当前算子对应PDNode及限制条件(算子类型、属性限制等);
2. 遍历当前算子对应输入并从pattern中尝试获取PDNode:
   - 在pattern中获取到PDNode且为输出节点:表示属于匹配子图的中间节点,将该PDNode设置为中间节点;
   - 在pattern中没有获取到PDNode:添加该输入PDNode并设置作为输入节点;
   - 设置输入到算子的边关系;
3. 遍历当前算子对应输出:
   - 在pattern中获取到PDNode且为输入节点:表示属于匹配子图的中间节点,将该PDNode设置为中间节点;
   - 在pattern中没有获取到PDNode:添加该输入PDNode并设置作为输出节点;
   - 设置算子到输出的边关系;

##### 根据替换子图操作graph

替换子图操作的过程在`GetGenerateRewrite`函数中完成,与`InitGeneratePattern`类似没有作为GeneratePass的成员方法。

生成替换子图操作过程如下:

1. 判断冗余替换子图;
2. 遍历替换子图program的全部算子添加替换子图Node:
   1. 添加当前算子的Node及属性设置;
   2. 遍历当前算子对应输入,添加中间variable节点;
   3. 遍历当前算子对应输出,添加中间variable节点;
   4. 添加输入/输出节点与算子节点的边关系;
3. 删除匹配图中属于中间节点的Node;

##### 优化子图验证

对于替换子图或者替换后的计算图是否可以正确运行等,可以在执行Pass时验证,从而防止在后续执行计算图时出现异常。

当前Pass执行直接修改计算图,验证失败时无法很好的完成还原操作,目前子图验证暂时默认成功,留到后续改进。
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants