Skip to content

Refine custom op docs #7292

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

Merged
merged 2 commits into from
Apr 25, 2025
Merged

Conversation

SigureMo
Copy link
Member

@SigureMo SigureMo commented Apr 24, 2025

@SigureMo SigureMo requested review from DrRyanHuang and Copilot April 24, 2025 17:18
Copy link

paddle-bot bot commented Apr 24, 2025

感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7292.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明,请参考:飞桨文档预览工具

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refines the documentation for custom C++ operators by improving formatting, fixing typos, and updating version links. Key changes include the correction of typos (e.g. "OpFucntion" to "OpFunction"), standardized inline code formatting and markdown backticks, and updated references from PaddlePaddle 2.3 to 3.0.

2. 调用 `python` 接口完成算子编译与注册

随后即可在模型中使用,下面通过实现一个 `relu` 运算,介绍具体的实现、编译与应用流程。

> 注意事项:
> - 在使用本机制实现自定义算子之前,请确保已经正确安装了 `PaddlePaddle 2.3` 及以上版本
> - 该机制已支持 `Linux` 、 `Mac` 和 `Windows` 平台。
> - 该机制已支持 `Linux`、`macOS` 和 `Windows` 平台。
> - 本自定义外部算子机制仅保证源码级别的兼容,不保证二进制级别的兼容,例如,基于飞桨 2.3 版本编写的自定义算子源码实现,在飞桨 2.3 或者后续版本中编译链接使用没有问题,但基于飞桨 2.3 之前的版本编译得到的自定义算子动态库文件(*.so, *.dylib, *.dll),在 2.3 或者后续发布的版本中可能会加载失败。
Copy link
Collaborator

Choose a reason for hiding this comment

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

这部分要不要之后改成飞桨 3.0 版本?

Copy link
Member Author

Choose a reason for hiding this comment

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

这里先不改了吧,这里确实是 2.3 写的文档,描述也没啥问题

@SigureMo SigureMo merged commit e67174a into PaddlePaddle:develop Apr 25, 2025
2 checks passed
@SigureMo SigureMo deleted the refine-custom-op-docs branch April 25, 2025 05:40
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