-
Notifications
You must be signed in to change notification settings - Fork 8k
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.
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
docs: Update README #13520
docs: Update README #13520
Conversation
- 低代码开发范式:支持 OCR 模型全流程低代码开发,提供 Python API,支持用户自定义串联模型; | ||
- 多硬件训推支持:支持英伟达 GPU、昆仑芯、昇腾和寒武纪等多种硬件进行模型训练与推理。PaddleOCR支持的模型见 [模型列表](doc/doc_ch/hardware/supported_models.md) | ||
- 低代码开发范式:支持 OCR 模型全流程低代码开发,提供 Python API,支持用户自定义串联模型; | ||
- 多硬件训推支持:支持英伟达 GPU、昆仑芯、昇腾和寒武纪等多种硬件进行模型训练与推理。PaddleOCR支持的模型见 [模型列表](doc/doc_ch/hardware/supported_models.md) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这个模型列表文件:doc/doc_ch/hardware/supported_models.md ,是不是有些误导? 我理解其他的模型应该也可以跑。 另外,这个列表里为什么没有 PPOCR ? : https://github.com/PaddlePaddle/PaddleX/blob/release/3.0-beta/docs/tutorials/models/support_npu_model_list.md ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这个doc
目录要删除,还得把这个文件移动到新位置。
@@ -74,185 +45,35 @@ PaddleOCR 由 [PMC](https://github.com/PaddlePaddle/PaddleOCR/issues/12122) 监 | |||
<img src="https://raw.githubusercontent.com/tink2123/test/master/ppocrv4.png"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这个的图片引用,改成用仓库里的 ./docs/images/ppocrv4.png 这个文件吧,不然 clone 到本地,打开的时候可能会无法显示。
- PP-OCRv4 在线体验地址:<https://aistudio.baidu.com/community/app/91660> | ||
- SLANet 在线体验地址:<https://aistudio.baidu.com/community/app/91661> | ||
- PP-ChatOCRv2-common 在线体验地址:<https://aistudio.baidu.com/community/app/91662> | ||
- PP-ChatOCRv2-doc 在线体验地址:<https://aistudio.baidu.com/community/app/70303> | ||
|
||
- 一行命令快速使用:[快速开始(中英文/多语言/文档分析)](./doc/doc_ch/quickstart.md) | ||
- 移动端 demo 体验:[安装包 DEMO 下载地址](https://ai.baidu.com/easyedge/app/openSource?from=paddlelite)(基于 EasyEdge 和 Paddle-Lite, 支持 iOS 和 Android 系统) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
移动端 demo 体验,点进去后没找到 DEMO 下载的地址,应该可以删掉了。
@@ -74,185 +45,35 @@ PaddleOCR 由 [PMC](https://github.com/PaddlePaddle/PaddleOCR/issues/12122) 监 | |||
<img src="https://raw.githubusercontent.com/tink2123/test/master/ppocrv4.png"> | |||
</div> | |||
|
|||
> 上述内容的使用方法建议从文档教程中的快速开始体验 | |||
|
|||
|
|||
## ⚡ 快速开始 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这一节是不是可以跳转到: https://paddlepaddle.github.io/PaddleOCR/quick_start.html 就好了。
|
||
## 许可证书 | ||
|
||
本项目的发布受<a href="https://github.com/PaddlePaddle/PaddleOCR/blob/master/LICENSE">Apache 2.0 license</a>许可认证。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
本项目的发布受<a href="https://github.com/PaddlePaddle/PaddleOCR/blob/master/LICENSE">Apache 2.0 license</a>许可认证。 | |
本项目的发布受 [Apache License Version 2.0](./LICENSE) 许可认证。 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
英文的是不是也要更新一下,链接一下,不然对国外用户不友好。
<div align="center"> | ||
<img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/test_add_91.jpg" width="800"> | ||
</div> | ||
|
||
<div align="center"> | ||
<img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/00006737.jpg" width="800"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
这几个图感觉不需要删除吧,不然readme有点干巴。还有图片地址改成完整的地址,不然在pypi上显示不出来。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
有干巴吗?
pypi上不建议放README内容,因为那里一旦发布,就不能更改。
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pypi里面内容不是根据release的readme显示的吗
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
是根据release的readme显示,一旦发布后,pypi的readme就不能改了。但是仓库的readme会一直更改。
这样存在信息失效问题
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
所以要把readme里面图片链接改成完整的地址,不然发布后会显示不出来。
所以不建议放完整README内容
---- Replied Message ----
| From | Wang ***@***.***> |
| Date | 07/26/2024 11:40 |
| To | PaddlePaddle/PaddleOCR ***@***.***> |
| Cc | SWHL ***@***.***>,
Author ***@***.***> |
| Subject | Re: [PaddlePaddle/PaddleOCR] docs: Update README (PR #13520) |
@GreatV commented on this pull request.
In README.md:
-<div align="center">
- <img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/test_add_91.jpg" width="800">
-</div>
-<div align="center">
- <img src="./doc/imgs_results/ch_ppocr_mobile_v2.0/00006737.jpg" width="800">
所以要把readme里面图片链接改成完整的地址,不然发布后会显示不出来。
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you authored the thread.Message ID: ***@***.***>
|
我指的是图片的地址,要完整的地址,而不是现在这种相对引用。是不用放完整README内容,这个没有问题。 |
你给它关掉干啥,这个PR没什么问题呀。 |
我不小心把我fork的删除了,正在重新提 [捂脸] |
因为官方文档的上线,可以适当简化当前仓库README,去掉和文档部分重复内容。