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

主流DL框架文档格式调研 #8834

Closed

ranqiu92 opened this issue Mar 7, 2018 · 1 comment · Fixed by #8927

Contributor

ranqiu92 commented Mar 7, 2018

以下为主流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

ranqiu92 added the documentation label

Contributor

luotao1 commented Mar 7, 2018

related #6160

This was referenced Mar 8, 2018

Discuss how to write API document #8866

Closed

Add api doc std #8927

Merged

luotao1 closed this as completed in #8927

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment