Skip to content

  • 体验新版
    • 正在加载...
  • 登录
  • PaddlePaddle
  • FluidDoc
  • Issue
  • #346

F
FluidDoc
  • 项目概览

PaddlePaddle / FluidDoc

通知 10
Star 2
Fork 0
  • 代码
    • 文件
    • 提交
    • 分支
    • Tags
    • 贡献者
    • 分支图
    • Diff
  • Issue 23
    • 列表
    • 看板
    • 标记
    • 里程碑
  • 合并请求 111
  • Wiki 0
    • Wiki
  • 分析
    • 仓库
    • DevOps
  • 项目成员
  • Pages
F
FluidDoc
  • 项目概览
    • 项目概览
    • 详情
    • 发布
  • 仓库
    • 仓库
    • 文件
    • 提交
    • 分支
    • 标签
    • 贡献者
    • 分支图
    • 比较
  • Issue 23
    • Issue 23
    • 列表
    • 看板
    • 标记
    • 里程碑
  • 合并请求 111
    • 合并请求 111
  • Pages
  • 分析
    • 分析
    • 仓库分析
    • DevOps
  • Wiki 0
    • Wiki
  • 成员
    • 成员
  • 收起侧边栏
  • 动态
  • 分支图
  • 创建新Issue
  • 提交
  • Issue看板
已关闭
开放中
Opened 11月 16, 2018 by saxon_zh@saxon_zhGuest

Python API注释优化需求

Created by: shanyi15

背景:

PM文档方向于近期走查了Paddle API Reference文档(基于v1.1),总结共计78个python api注释中存在以下问题:

1) 文字描述较少、抽象,很难理解 2) 参数说明错误或不齐全 3) 代码示例错误或不齐全 4) 格式混乱

其中代码示例错误和格式混乱的问题共计42个,将由PM进行修复 剩余问题总结如下,辛苦研发老师支持修复

由于API文档对用户使用体验影响较大,我们将提升此项工作的优先级,期望在v1.2前修复,并随v1.2上线

需要研发老师支持修复的API注释

  1. _switch_scope:

    没有文档内容

  2. staticRNN

    参数说明不完整,缺少代码示例

  3. shuffle

    内容过于简略,缺少参数说明和代码示例

  4. DynamicRNN

    缺少部分参数说明,格式错误

    block中的 class docstring 是否写错了呢

图片

  1. ctc_greedy_decoder

    看了案例感觉不是很懂 output代表什么,希望优化文字描述

  2. resize_bilinead

    缺少代码示例

  3. 'elu','relu6','pow','stanh','hard_sigmoid','swish', 'prelu','brelu','leaky_relu','soft_relu'

    这些API,缺少代码示例

  4. 'uniform_random_batch_size_like','gaussian_random','sampling_id','gaussian_random_batch_size_like','sum','slice', 'shape','logical_and','logical_or','logical_xor','logical_not','clip','clip_by_norm','mean','mul','sigmoid_cross_entropy_with_logits','maxout'

    这些API,缺少代码示例

  5. append_LARS

    目前内容有些混乱,需要修改一下

  6. polygon_box_transform

    缺少代码示例

  7. force_init_on_cpu

    文字说明需要补充,该API如何应用呢?

  8. weightedAverage

说明文字较简略,缺少代码示例 image

指派人
分配到
无
里程碑
无
分配里程碑
工时统计
无
截止日期
无
标识: paddlepaddle/FluidDoc#346
渝ICP备2023009037号

京公网安备11010502055752号

网络110报警服务 Powered by GitLab CE v13.7
开源知识
Git 入门 Pro Git 电子书 在线学 Git
Markdown 基础入门 IT 技术知识开源图谱
帮助
使用手册 反馈建议 博客
《GitCode 隐私声明》 《GitCode 服务条款》 关于GitCode
Powered by GitLab CE v13.7