Created by: ranqiu92

以下为主流DL框架的文档格式:

PyTorch

• Code Definition (definition and source link)
• Brief Introduction (necessary formula and symbols' description)
• Note
• Parameters description (including data type and default value)
• Inputs (shape, description)
• Outputs (shape, description)
• Variables (if have learnable network parameters, the description)
• Usage Example

TensorFlow

• Code Definition
• Code Source Link
• Guide
• Brief Introduction
• Note
• Usage Example
• Args description (optional attribute)
• Return Value Description
• Potential Exception

CNTK

• Brief Introduction (one sentence)
• Code Definition
• Parameters (description, default value, optional attribute)
• Return Value Description
• Description (function， details)
• Usage Example

MxNet

• Code Definition (source code link)
• Brief Introduction (necessary formula)
• Parameters (description, data type, default value)
• Inputs (shape, description)
• Outputs (shape, description)
• Usage Example