Skip to content

Introduction framework#44

Merged
terayco merged 70 commits intoPaddleCV-SIG:developfrom
terayco:Introduction
Oct 31, 2022
Merged

Introduction framework#44
terayco merged 70 commits intoPaddleCV-SIG:developfrom
terayco:Introduction

Conversation

@terayco
Copy link
Copy Markdown
Member

@terayco terayco commented Oct 26, 2022

写了个使用文档的大致雏形,之后慢慢完善~

@Bobholamovic
Copy link
Copy Markdown
Member

CI的codestyle检查没有过,麻烦看一下哈~

@Bobholamovic Bobholamovic self-requested a review October 27, 2022 08:05
Copy link
Copy Markdown
Member

@Bobholamovic Bobholamovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

文档部分修改意见如下:

  1. 将图片存放在项目内可能导致随着项目更新,项目体积越来越大。建议的做法是使用GitHub作为图床。具体的做法为:在我新建的这个issue里通过回复comment的方式把图片传到GitHub上,然后在右键复制图片链接即可。
  2. 导出解译结果的部分比较重要,最好也附配一下文档。
  3. 我认为『预处理』这个词有些不妥,因为去噪也是预处理的一种,区分『预处理』和『降噪』不太合适。目前项目里用到的CLAHE和锐化都是图像增强,因此我认为可以把『预处理』改为『增强』。
  4. 编写markdown时应该适当增加空行增强可读性(我们的pre-commit钩子没有对这方面做强制格式要求)。
  5. docs/dev.md中的图片和描述不一致(change_detection vs change_detector),需要更新。
  6. 撰写文档时注意一些用词。尽量减少用『系统』(因为我们这次写的不是系统设计文档,大多是给用户看的),需要自称时可以用『本项目』(仅限于描述项目本身,而不能用于描述程序)或『PP-GeoView』(可用于描述项目本身或运行中的程序)。『文件夹』和『目录』并不等同,前者是GUI中的概念(面向用户),后者是系统中的概念,所以我认为面向开发者的文档应当尽可能用『目录』(除非明确描述的是GUI里的东西),例如,『创建目录』;面向用户的应该尽可能用『文件夹』,因为用户实际接触的是GUI。此外,因为是写给用户看的,所以可以用第二人称『您应该』,比第三人称『用户应该』更亲切。

我对原有的文档做了结构调整,将文档部分按照面向的群体拆分为『开发者需要阅读的』和『使用者(用户)需要阅读的』。此外,我更新了docs/semantic_segmentation.md文档,其他几个任务可以参考docs/semantic_segmentation.md文档的写法修改。

@terayco terayco merged commit cd05c44 into PaddleCV-SIG:develop Oct 31, 2022
@Bobholamovic Bobholamovic linked an issue Oct 31, 2022 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] 添加基础使用文档。

4 participants