Administrator/NANOKVM-sipeed_wiki-MIRROR
1
0
Fork 0
mirror of https://github.com/sipeed/sipeed_wiki.git synced 2026-09-11 00:22:49 -05:00
Code Issues Packages Projects Releases Wiki Activity

update add_doc zh

Browse Source
This commit is contained in:
wonderfullook
2022-09-08 19:08:58 +08:00
parent 29727d4df5
commit d7fb31a43b
22 changed files with 152 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/hardware/assets/metasense.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 38 KiB

6
docs/hardware/en/README.md
View File

@@ -4,8 +4,6 @@ keywords: Sipeed, Hardware, Sipeed, Hardware specifications, Documentation, Down
desc: Sipeed hardware documentation website desc: Sipeed hardware documentation website
--- ---
# Sipeed Hardware WIKI
## Maix Series ## Maix Series
A series of development boards based on **K210**, meets the needs of different groups of people A series of development boards based on **K210**, meets the needs of different groups of people
@@ -32,7 +30,9 @@ FPGA Development board
## Metasense Module ## Metasense Module
Waiting picture 3D TOF Module
[![](./../assets/metasense.jpg)](./metasense/readme.md)
## Longon Series ## Longon Series

4
docs/hardware/en/tang/Tang-Nano-Doc/summary.md
View File

@@ -1,9 +1,7 @@
--- ---
title: Summary title: Tang Nano
--- ---
> Edit on 2022.04.06
Tang Nano series development boards are designed based on [Gowin](https://www.gowinsemi.com/en/) FPGA chip. Mutiple models of development board meets various requirements. Tang Nano series development boards are designed based on [Gowin](https://www.gowinsemi.com/en/) FPGA chip. Mutiple models of development board meets various requirements.
- Tang nano 1K with a extremely low price can lead user into FPGA fields - Tang nano 1K with a extremely low price can lead user into FPGA fields
- Tang nano 4K with a Cortex m3 hardcore, almost the cheapest heterogeneous core board - Tang nano 4K with a Cortex m3 hardcore, almost the cheapest heterogeneous core board

6
docs/hardware/en/tang/readme.md
View File

@@ -1,8 +1,6 @@
# Tang Serial Development Board # Tang Series Development Board
> Overview Tang Series development boards are devided into Tang Nano series development boardand Tang Primer series development board.
Tang Serial development boards are devided into Tang Nano serial development boardand Tang Primer serial development board.
## Product on sale ## Product on sale

4
docs/hardware/zh/README.md
View File

@@ -30,7 +30,9 @@ FPGA 开发板
## Metesense 模组 ## Metesense 模组
待插入图片 3D TOF 模组
[![](./../assets/metasense.jpg)](./metasense/readme.md)
## Longon 系列 ## Longon 系列

14
docs/soft/maixpy/zh/course/ai/train/maixhub.md
View File

@@ -9,16 +9,4 @@ desc: Maixhub 模型训练
Maixhub 提供模型训练功能和模型分享功能， 只需要准备好需要训练的数据集， 不需要搭建训练环境和代码， 上传训练数据即可快速训练出模型，方便快速制作你的 AI 应用，或者入门学习 AI 训练的流程和原理。 Maixhub 提供模型训练功能和模型分享功能， 只需要准备好需要训练的数据集， 不需要搭建训练环境和代码， 上传训练数据即可快速训练出模型，方便快速制作你的 AI 应用，或者入门学习 AI 训练的流程和原理。
另外你也可以在 MaixHub 模型库下载你喜欢的模型，甚至上传分享你自己制作的模型，不管是在maixhub训练的，还是自己写代码训练的各种有意思的模型！ 另外你也可以在 MaixHub 模型库下载你喜欢的模型，甚至上传分享你自己制作的模型，不管是在maixhub训练的，还是自己写代码训练的各种有意思的模型！

11
news/maixhub/new_maixhub.md
View File

@@ -6,8 +6,6 @@ tags: maixhub, 模型训练
cover: ./images/deploy.gif cover: ./images/deploy.gif
--- ---
先看看效果， 一个检测小鸭子（可同时检测多个相同或者不同目标），另外一个是表情分类模型： 先看看效果， 一个检测小鸭子（可同时检测多个相同或者不同目标），另外一个是表情分类模型：
![deploy](./images/deploy.gif) ![deploy](./images/deploy.gif)
@@ -87,7 +85,6 @@ cover: ./images/deploy.gif
更多功能持续在更新~ 持续关注哦~ 也欢迎来上传分享你自己的模型！ 更多功能持续在更新~ 持续关注哦~ 也欢迎来上传分享你自己的模型！
## 训练优化建议 ## 训练优化建议
* 尽量多采集实际使用场景的图片，覆盖更多使用场景有利于提高最终识别率。 * 尽量多采集实际使用场景的图片，覆盖更多使用场景有利于提高最终识别率。
@@ -96,10 +93,4 @@ cover: ./images/deploy.gif
* 为了让验证集的精确度的可信度更高（也就是在实际开发板上跑的精确度更接近训练时在验证集上的精确度），验证集的数据和实际应用的场景数据一致。比如训练集是在网上找了很多图片，那这些图片可能和实际开发板的摄像头拍出来的图有差距，可以往验证集上传一些实际设备拍的图来验证训练的模型效果。 * 为了让验证集的精确度的可信度更高（也就是在实际开发板上跑的精确度更接近训练时在验证集上的精确度），验证集的数据和实际应用的场景数据一致。比如训练集是在网上找了很多图片，那这些图片可能和实际开发板的摄像头拍出来的图有差距，可以往验证集上传一些实际设备拍的图来验证训练的模型效果。
这样我们就能在训练的时候根据验证集精确度（val_acc）来判断模型训练效果如何了，如果发现验证集精确度很低，那么就可以考虑增加训练集复杂度和数量，或者训练集用设备拍摄来训练。 这样我们就能在训练的时候根据验证集精确度（val_acc）来判断模型训练效果如何了，如果发现验证集精确度很低，那么就可以考虑增加训练集复杂度和数量，或者训练集用设备拍摄来训练。
* 对于检测训练项目，如果检测训练的物体很准，但是容易误识别到其它物体，可以在数据里面拍点其它的物体当背景；或者拍摄一些没有目标的图片，不添加任何标注也可以，然后在训练的时候勾选“允许负样本”来使能没有标注的图片。 * 对于检测训练项目，如果检测训练的物体很准，但是容易误识别到其它物体，可以在数据里面拍点其它的物体当背景；或者拍摄一些没有目标的图片，不添加任何标注也可以，然后在训练的时候勾选“允许负样本”来使能没有标注的图片。
* 检测任务可以同时检测到多个目标，如果你觉得识别类别不准，也有另外一种方式，先只检测模型检测到物体（一个类别），然后裁切出图片中的目标物体上传到分类任务，用分类任务来分辨类别。不过这样就要跑两个模型，需要写代码裁切图片（在板子跑就好了），以及需要考虑内存是否足够 * 检测任务可以同时检测到多个目标，如果你觉得识别类别不准，也有另外一种方式，先只检测模型检测到物体（一个类别），然后裁切出图片中的目标物体上传到分类任务，用分类任务来分辨类别。不过这样就要跑两个模型，需要写代码裁切图片（在板子跑就好了），以及需要考虑内存是否足够

7
pages/index/en/tang.md
View File

@@ -1,3 +1,4 @@
<head> ---
<meta http-equiv="refresh" content="0.1;url=/soft/Tang/en/index_bak.html"> layout: redirect
</head> redirect_url: /hardware/en/tang/index.html
---

92
share_docs/zh/add_doc.md
View File

@@ -1,21 +1,97 @@
# 分享文档 # 分享文档
如果你有什么好的文档想分享出来的话，可以上传到 wiki 上 如果你有什么好的文档想分享出来的话，可以通过 github 来分享到我们的 wiki 上面。
下面是操作步骤： 这里说明一些方法:
--- ## 添加纯文本内容
目前 wiki 主要网页支持 markdown 和 ipynb 两种文档 目前 wiki 主要网页支持 markdown 和 ipynb 两种文档。
我们在 https://github.com/sipeed/sipeed_wiki/tree/main/docs 页面选择 'Upload files' 当然需要先登录进 github，然后在 https://github.com/sipeed/sipeed_wiki 页面选择 'Upload files'
![添加文件](./assets/upload.png) ![upload](./assets/upload.png)
在接下来的页面中我们**把想要分享的文档直接拖拽到红框处，比如下图紫框中就是已经上传的文件，然后在蓝框中补充说明一下**。最后可以点击绿色的 `Commit changes` 来进行提交了 这个时候会发现因为没有权限而被禁止上传。
![增加文件](./assets/added.png) ![unable_upload](./assets/unable_upload.png)
点一下右上角的 Fork 来克隆一份到我们自己的仓库。
![create_fork](./assets/create_fork.png)
这样我们就可以在自己所 Fork 的仓库里面添加文件 'Upload Files' 了。
![fork_upload_files](./assets/fork_upload_files.png)
在接下来的页面中我们**把想要分享的文档直接拖拽到红框处，比如下图紫框中就是已经上传的文件，然后在蓝框中补充说明一下**。最后可以点击绿色的 `Commit changes` 来在自己所 Fork 的仓库提交了
![added](./assets/added.png)
提交完之后我们需要把自己的更改合并到 sipeed wiki 的 github 仓库
![fork_pull_request](./assets/fork_pull_request.png)
仓库管理员看到后会根据蓝框中的说明把文档移植到正确的位置。 仓库管理员看到后会根据蓝框中的说明把文档移植到正确的位置。
> 感谢参与建设开源文档
## 添加包含图片的内容
因为添加图片的文档在 wiki 上面显示效果可能与在编辑器里所看到的效果不一样，因此建议在本地构建一下 wiki 来查看自己所编写的文档在 wiki 上面显示的实际结果，所以不建议像上面一样直接 `Upload Files`。
需要先 Fork Sipeed 的仓库，这样自己就可以编辑 wiki 仓库了（当然所编辑的仓库应该是你所 Fork 的），然后自己将所 Fork 的仓库 Clone 到本地，这样在后面完成添加文档后就能够直接将所 clone 的仓库推送到远程仓库了，不然可能会因为权限相关的问题导致不少麻烦~
对于下面的命令，我们需要将第一行的 `https://github.com/sipeed/sipeed_wiki.git` 替换成我们所 Fork 为自己的仓库的地址
```bash
git clone https://github.com/sipeed/sipeed_wiki.git
pip install teedoc
cd sipeed_wiki
teedoc install
teedoc serve
```
在我们所 Fork 的 Sipeed wiki 的仓库中，点击下图所标注的位置来获得当前仓库的地址。
![copy_forked_url](./assets/copy_forked_url.png)
这里以所获得的仓库地址 https://github.com/example/sipeed_wiki.git 为例，将上面的命令行改成下面的形式就可以直接 clone、在本机构建 wiki 网站了，然后访问 [127.0.0.1:2333](127.0.0.1:2333) 查看构建效果。
```bash
git clone https://github.com/example/sipeed_wiki.git
pip install teedoc
cd sipeed_wiki
teedoc install
teedoc serve
```
wiki 仓库里面的主要文档存在的文件目录如下：
```bash
.
├── docs ## 文档路径
│   ├── hardware ## 产品文档
│   └── soft ## 软件文档
└── news ## 博文精选
```
文档文件以 markdown 和 ipynb 为主，需要会相关语法~
一般来说添加内容到 news/ 就可以；自己新建文件夹然后添加内容。
然后可以在本地电脑所构建的 wiki 的博文精选里面看到自己所添加文档在 wiki 上面的实际显示效果了。
![view_result](./assets/view_result.png)
自己对添加内容满意的话，将本地的仓库推送到远程的 github 仓库，接着给 Sipeed wiki 仓库提交代码。
![fork_pull_request](./assets/fork_pull_request.png)
点击上面的 `Open pull request` 后会打开下图的界面，我们选择 `Create pull request` 即可后就提交上去了。
![create_pr](./assets/create_pr.png)
仓库管理员看到之后，会在确认合理、可用后接受提交申请。
> 感谢参与建设开源文档 > 感谢参与建设开源文档

BIN
share_docs/zh/assets/able_merge.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 48 KiB

BIN
share_docs/zh/assets/copy_forked_url.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 98 KiB

BIN
share_docs/zh/assets/create_fork.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 53 KiB

BIN
share_docs/zh/assets/create_pr.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 70 KiB

BIN
share_docs/zh/assets/fork_pull_request.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 81 KiB

BIN
share_docs/zh/assets/fork_pull_request_finish.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB

BIN
share_docs/zh/assets/fork_upload_files.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 84 KiB

BIN
share_docs/zh/assets/unable_upload.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
share_docs/zh/assets/upload.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 33 KiB

After

Width:  |  Height:  |  Size: 33 KiB

BIN
share_docs/zh/assets/view_result.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 85 KiB

51
share_docs/zh/change_doc.md
View File

@@ -1,43 +1,70 @@
# 编辑文档 # 编辑文档
现在的文档仓库数量庞大，存在着一些编者都没有注意的错误。 现在的 wiki 仓库内容过多，部分文档存在着一些没注意到的错误。
当读者发现错误的时候，可以进行修改。 当读者发现错误的时候，可以自行进行修改。
可以分为几个步骤：
- 定位文档 -> 编辑本页
- 登录 github
- 编辑文档
- 增加修改说明
- 提交 PR
## 定位文件 ## 定位文件
进入需要修改的文档页面，点击 “编辑本页” 进入需要修改的文档页面，点击 “编辑本页” 后会跳转到文档所在的 github 的网址.
![点击编辑本页](./assets/edit_page.png) ![点击编辑本页](./assets/edit_page.png)
就会跳转到想要修改页面所在的 github 原文件位置。~~github 上不去的话很正常~~ 没能够成功跳转的话可以尝试刷新网页或者自行搜索一下 github 打开方式（你以后会用得到）
成功跳转后会看到类似如下的界面：
![github页面](./assets/github_pages.png) ![github页面](./assets/github_pages.png)
## 登录 github ## 登录 github
因为 github 上对于仓库所做的任何更改都会留下相关记录，所以需要登录账号来确定相关身份。
点击 github 页面右上角的 `sign in` 来登陆账号 点击 github 页面右上角的 `sign in` 来登陆账号
![github_login](./../assets/2.png) ![github_login](./../assets/2.png)
## 修改文档 ## 修改文档
点击下图所框出的图标就可以编辑当前文件。
![edit_github_page](./assets/edit_github_page.png) ![edit_github_page](./assets/edit_github_page.png)
点击上图所框出的图标来编辑当前文件，就相当于直接对 wiki 网页编辑了。 wiki 文档文件主要以 markdown 为主，少部分为 ipynb 。
文件主要以 markdown 为主，少部分为 ipynb 。
编辑页面如下所示，其中两个红框分别是 编辑文件 页面和 预览 页面。编辑时可以随时切换到预览页面来查看一下编辑结果 点击编辑当前文件后的界面如下所示，其中两个红框分别是 编辑文件 页面和 预览 页面。
编辑文件时可以切换到预览页面来查看一下编辑效果。
![edit_preview](./assets/edit_preview.png) ![edit_preview](./assets/edit_preview.png)
## 提交 ## 增加修改说明
文档修改完毕后，需要在编辑框最底下进行提交。
文档修改完毕后，在编辑框最底下进行提交。
可以在红框中简述修改信息，并且在蓝框中补充说明。 可以在红框中简述修改信息，并且在蓝框中补充说明。
也可以不进行说明直接点下方的绿色的 'Commit Changes'来进行提交 也可以不进行说明直接点下方的绿色的 `Commit Changes` 来进行提交
![](./assets/commit.png) ![commit_changes](./assets/commit.png)
仓库管理员看到之后，会在确认可用之后合并到仓库中。 ## 提交 PR
进行完上面的修改说明后，会跳转到如下图所示的界面。
![able_merge](./assets/able_merge.png)
出现下图红框处的 `Able to merge` 的话就说明能够正常提交了，这个时候点击如图右下方的 `Create pull request` 来提交申请。
点击下图中的 `Create pull request` 来确定提交。
![create_pr](./assets/create_pr.png)
仓库管理员看到之后，会在确认合理、可用后接受提交申请。
> 感谢参与建设开源文档 > 感谢参与建设开源文档

6
share_docs/zh/readme.md
View File

@@ -1,10 +1,8 @@
# 修改 wiki # 修改 wiki
有时候 wiki 文章中会有一些错误，或者大家有什么好的文章想分享。 wiki 文档中可能会有一些错误，或者大家有什么好的文章想分享的话，就需要编辑 wiki 了。
就可以按照下面的两种方法来更改 wiki 。 下面根据不同的场景来进行相关方式说明：
这里提供 修改 和 分享 文档得两种方式
- [**修改文档**](./change_doc.md) <--点它 - [**修改文档**](./change_doc.md) <--点它

21
share_docs/zh/sidebar.json
View File

@@ -2,15 +2,18 @@
"items": [ "items": [
{ {
"label": "简介", "label": "简介",
"file" : "./readme.md" "file": "./readme.md",
}, "collapsed": false,
{ "items": [
"label": "修改页面", {
"file" : "./change_doc.md" "label": "修改页面",
}, "file": "./change_doc.md"
{ },
"label": "添加文档", {
"file" : "./add_doc.md" "label": "添加文档",
"file": "./add_doc.md"
}
]
} }
] ]
} }