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.

Sign up for GitHub

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

Jump to bottom

Record links of all .md files in the fluid directory #8976

Closed
weixing02 opened this issue Mar 11, 2018 · 4 comments
Closed

Record links of all .md files in the fluid directory #8976

weixing02 opened this issue Mar 11, 2018 · 4 comments

Comments

@weixing02
Copy link
Collaborator

related #8587
links of all .md files in the fluid directory:
@shanyi15
Copy link
Collaborator

shanyi15 commented Mar 13, 2018 •
edited
Loading

我归纳的分类，欢迎大家提议

  1. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/memory/README.md
    基于区域的异构内存管理 是design doc
  2. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/operators/op_documentation/rnn_design.md
    RNN 变长输入设计 是design doc
  3. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/operators/op_documentation/net_op_design.md
    网络设计 是design doc
  4. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/operators/op_documentation/name_convention.md
    operator参数命名规范 建议放在“开发标准”
  5. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/operators/op_documentation/batch_norm_op.md
    批归一化 是不是放在“进阶使用”里？
  6. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/operators/op_documentation/op_markdown_format.md
    Operators标准md格式 是不是放在“开发标准”？
  7. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/framework/variable.md
    变量 是设计文档还是基本使用概念？
  8. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/framework/tensor.md
    张量 是设计文档还是基本使用概念？
  9. https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/fluid/framework/lod_tensor.md
    LODz张量 这个也许更偏向于“设计文档”

@luotao1
Copy link
Contributor

luotao1 commented Mar 13, 2018

Operators标准md格式 是不是放在“开发标准”？

请 @ranqiu92 和 API注释标准 #8927 一起考虑下。

变量 是设计文档还是基本使用概念？

variable, tensor, lod_tensor都属于设计文档里的核心概念。

@shanyi15
Copy link
Collaborator

shanyi15 commented Mar 13, 2018 •
edited
Loading

新手入门

基本使用概念

【保存模型】
https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/model_format.md
Design Doc: Model Format

设计思想

设计动机和目标

执行流程

  1. 编译时流程
  2. 运行时流程
  3. 像写程序一样定义计算
    (1) https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/switch.md
    Design Doc: Switch
    (2) https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/if_else_op.md
    The IfElse Operator

核心概念

  1. 编译时概念
  1. 运行时概念

数据类型

内存管理

多设备支持

Dynamic RNN

并发编程

梯度更新算法

https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/parameter_average.md

复杂网络设计

代码结构和重要模块

fluid系统形态

待定

多语言接口

https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/multi_language_interface/00.why_plain_c.md
Paddle多语言接口实现

https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/multi_language_interface/01.inference_implementation.md
C-API 模型推断实现文档

分布式训练

这部分已挪到doc/fluid/design/dist_train 目录下
详情请参考： #9023
#9028

Others

-https://github.com/PaddlePaddle/Paddle/blob/develop/doc/design/gan_api.md
gan 这是一篇v2的文档，但此功能在v2没有实现，fluid可能会有这个功能，在写文档时可能会参考此文档

进阶使用

性能分析与调优

第三方库

开发标准

不知道如何分类的

@shanyi15
Copy link
Collaborator

shanyi15 commented Mar 13, 2018 •
edited by luotao1
Loading

批归一化 是不是放在“进阶使用”里？

@JiayiFeng 建议批归一化放设计文档，用户看这个太深了。

This was referenced Mar 13, 2018
Closed
Closed
@luotao1 luotao1 closed this as completed Mar 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@luotao1 @weixing02 @shanyi15