[Doc Link Fix No.100] Fix docs link in page torch.optim.Optimizer.state_dict.md#7780
Conversation
|
感谢你贡献飞桨文档,文档预览构建中,Docs-New 跑完后即可预览,预览链接:http://preview-pr-7780.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html |
|
@SigureMo 已自查 diff:仅修复 1 处失效链接(会跳到 docs 首页 -> 正确 API 锚点),辛苦 review 一下喵~ |
📚 本次 PR 文档预览链接(点击展开)
|
83565f5 to
466ec3c
Compare
|
已修复,之前误将链接改为了不完整的相对路径,现已替换为英文 API 文档链接(中文文档页面无
请 @SigureMo 再看看~ 🐱 |
| ``` | ||
|
|
||
| ### [paddle.optimizer.Optimizer.state_dict](https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/api/paddle/optimizer/Optimizer/state_dict_cn.html#paddle/optimizer/Optimizer/state_dict_cn#cn-api-paddle-optimizer-Optimizer-state_dict) | ||
| ### [paddle.optimizer.Optimizer.state_dict](https://www.paddlepaddle.org.cn/documentation/docs/en/api/paddle/optimizer/Optimizer_en.html#state_dict) |
There was a problem hiding this comment.
我觉得我们还应该调整一下:
- 对于有中文文档的 API,直接将中文文档贴上
- 对于没有中文文档但有英文文档的 API,意味着该 API 明明是公开 API,但该 API 遗失了中文文档,你应该补充中文文档(从英文文档翻译而来,格式按照参考其他中文文档),并将中文文档贴上去
- 对于中英文文档都没有的,意味着该 API 非公开 API,直接贴 GitHub 源码的 permalink
这个 PR 按照上面说的来搞一下吧,顺带 #7782 的中文文档也在这个 PR 补一下吧
There was a problem hiding this comment.
已按照你的建议修改:
- 补充了中文文档:在
Optimizer_cn.rst中补充了state_dict()、set_state_dict()、load_state_dict()三个方法的中文文档(从英文文档翻译而来,格式参考了现有方法的格式) - 更新了 state_dict 链接:改为指向中文文档
Optimizer_cn.html#state-dict - 更新了 load_state_dict 链接([Doc Link Fix No.99] Fix docs link in page
torch.optim.Optimizer.load_state_dict.md#7782 的内容):改为指向中文文档Optimizer_cn.html#load-state-dict-state-dict
SigureMo
left a comment
There was a problem hiding this comment.
冲突了啊,得解决下
另外这种添加中文文档的,记得在 PR 描述指出英文文档在哪
...convert_from_pytorch/api_difference/invok_only_diff/torch.optim.Optimizer.load_state_dict.md
Show resolved
Hide resolved
0268d17 to
4cabe03
Compare
|
已解决冲突并更新了 PR 描述,补充了英文文档链接说明,详见 PR 描述中的「补充的中文文档」部分。 |
|
@SigureMo 确认过了,这个 anchor 是正确的喵~ 在 中, 的方法标题是 对比同文件中的其他方法:
所以当前链接 |
|
补充说明:在 Optimizer_cn.rst 中,方法标题格式决定了 anchor:
当前链接是正确的 ✅ |
|
|
||
| **代码示例** | ||
|
|
||
| COPY-FROM: paddle.optimizer.Optimizer.load_state_dict |
There was a problem hiding this comment.
顺序和英文文档保持一致吧,这三个 API 挪到 get_lr 之前
…ict and fix links - Add state_dict(), set_state_dict(), load_state_dict() methods to Optimizer_cn.rst - Update state_dict mapping link to Chinese docs - Update load_state_dict mapping link to Chinese docs (from PaddlePaddle#7782)
4cabe03 to
5e9fbaf
Compare
ShigureNyako
left a comment
There was a problem hiding this comment.
已调整顺序,将 state_dict/set_state_dict/load_state_dict 移到 get_lr 之前,与英文文档保持一致
|
已修复 review 意见:将 state_dict/set_state_dict/load_state_dict 三个 API 移到 get_lr 之前,与英文文档顺序保持一致。 |
修复内容
任务 100: torch.optim.Optimizer.state_dict.md
补充的中文文档
本 PR 补充了以下 API 的中文文档(翻译自英文文档):
Optimizer.state_dict()
Optimizer.set_state_dict()
Optimizer.load_state_dict()
验证结果
已手动访问更新后的链接,确认不再重定向到 docs 首页。
Related links: