【Docathon】补充缺失的中文 API 文档（Inplace 类） (original) (raw)
Navigation Menu
Appearance settings
- AI CODE CREATION
* GitHub CopilotWrite better code with AI
* GitHub SparkBuild and deploy intelligent apps
* GitHub ModelsManage and compare prompts
* MCP RegistryNewIntegrate external tools - DEVELOPER WORKFLOWS
* ActionsAutomate any workflow
* CodespacesInstant dev environments
* IssuesPlan and track work
* Code ReviewManage code changes - APPLICATION SECURITY
* GitHub Advanced SecurityFind and fix vulnerabilities
* Code securitySecure your code as you build
* Secret protectionStop leaks before they start - EXPLORE
* Why GitHub
* Documentation
* Blog
* Changelog
* Marketplace
- AI CODE CREATION
- BY COMPANY SIZE
* Enterprises
* Small and medium teams
* Startups
* Nonprofits - BY USE CASE
* App Modernization
* DevSecOps
* DevOps
* CI/CD
* View all use cases - BY INDUSTRY
* Healthcare
* Financial services
* Manufacturing
* Government
* View all industries
- BY COMPANY SIZE
- EXPLORE BY TOPIC
* AI
* Software Development
* DevOps
* Security
* View all topics - EXPLORE BY TYPE
* Customer stories
* Events & webinars
* Ebooks & reports
* Business insights
* GitHub Skills - SUPPORT & SERVICES
* Documentation
* Customer support
* Community forum
* Trust center
* Partners
- EXPLORE BY TOPIC
- COMMUNITY
* GitHub SponsorsFund open source developers - PROGRAMS
* Security Lab
* Maintainer Community
* Accelerator
* Archive Program - REPOSITORIES
* Topics
* Trending
* Collections
- COMMUNITY
- Pricing
Provide feedback
We read every piece of feedback, and take your input very seriously.
Include my email address so I can be contacted
Saved searches
Use saved searches to filter your results more quickly
Appearance settings
PaddlePaddle / docs Public
Notifications You must be signed in to change notification settings
Additional navigation options
Closed
Closed
【Docathon】补充缺失的中文 API 文档（Inplace 类）
#7090
Assignees
Description
opened
Note
上一期参考： #6193
背景
飞桨官网的 API 文档，有中文和英文两个版本，都存储于 GitHub 中，并通过技术手段转为 HTML 文件后呈现在官网。
中文 API 文档存储于 docs 仓库下，具体路径为 PaddlePaddle/docs/docs/api/paddle。英文 API 文档存储于 Paddle 仓库下的对应的 API 源码中，具体路径为 PaddlePaddle/Paddle/python/paddle。
以 paddle.add 为例，在 develop 分支下
- 中文文档 URL： https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/add_cn.html ，
api/paddle/add_cn.html即对应 docs/docs/api/paddle/add_cn.rst - 英文文档 URL：https://www.paddlepaddle.org.cn/documentation/docs/en/develop/api/paddle/add_en.html ， 进入文档页面中点击 [source] 即可跳转至 add 源代码中。
原则上官网 API 文档必须提供中文和英文两个版本，但目前许多 API 文档只提供了英文版本，而缺失了中文版本，导致这些API不容易被开发者发现和有效利用。为了解决这个问题，我们号召大家一起努力来补充这些 API 的中文文档。
任务结束后，完成该任务的开发者将会在官网中进行展示哦🎉
任务描述：
我们提供了 Inplace 类的中文文档的 API 清单，如下所示。请根据提供的 API 的英文文档，来补充相应的中文文档。
Inplace 含义见 Tensor 介绍 3.1.3 节
Warning
注意：补充文档时，还需要注意下是否需要在相应的 overview.rst 等综述页面增加相关 API 描述，如 paddle/Overview_cn.rst
任务认领
Note
1. Issue 回复格式：
为了自动填写报名信息，需要在 issue 下回复报名信息，如果报名格式不正确，则会在 comment 区提示报名不正确，格式如下：
【报名】: 2、3、6-10
其中【报名】: 后直接是报名的赛题序号，多个赛题之间需要用中文顿号
、分隔，多个连续赛题可以用横线表示
Note
2. PR 标题格式：
[Docathon][Add Inplace CN Doc No.2、3、6-10]
PR的标题中以 [Docathon][Add Inplace CN Doc No.xxxx] 开头即可，程序会自动提取赛题编号并更新榜单。
一个 PR 也可以提交多个赛题，多个赛题间以顿号或横线分隔，比如 No.24、26-28、30 赛题。
Note
3. PR 内容：
描述新增了什么文档、附上该 issue 链接、 附上英文文档链接、并 @sunzhongkai588 review
参考资料：
看板信息
| 任务方向 | 任务数量 | 提交作品 / 任务认领 | 提交率 | 完成 | 完成率 |
|---|---|---|---|---|---|
| 补充缺失的中文 API 文档（Inplace 类） | 47 | 47 / 47 | 100.0% | 47 | 100.0% |
统计信息
排名不分先后 @Echo-Nie (13) @APPARENT1 (6) @Keywennn (2) @hanlintang (6) @crashbussy (1) @superdonkey007 (1) @ZJhorseloudly (2) @Lorenz5622 (1) @mayiru1021 (4) @GKLeong (1) @LanCole (2) @Ismoothly (1) @lygitgit (2) @nuclearslippers (1) @zhaop-l (4)
Metadata
Metadata
Assignees
Labels
No labels
No labels
Type
No type
Projects
Status
Done
Milestone
No milestone
Relationships
None yet
Development
No branches or pull requests