DeepWiki:GitHub 仓库的智能百科全书
昨天,程序员界发生了一件大事。
Cognition AI 公司推出了一款产品:DeepWiki,既然叫 Wiki 大家就明白了,就像是维基百科一样,只不过 DeepWiki 是 给 GitHub 搭建的百科全书。
它的作用就是主要用于帮助开发者快速了解 GitHub 仓库内容,为 GitHub 仓库提供自动生成类似 Wikipedia 的交互式文 档和交互式分析功能。
产品概述
一般来讲,GitHub 仓库的 README 文件是有开发者自己写的,很多开发者写的可能简略或难以理解,尤其是对于大型或复 杂的项目,不能只通过 README 文件就能完全讲清楚。
对于学习者来讲,看简略的 README 可能学习起来门槛就比较高,不能足够让大家了解。
DeepWiki 则通过 AI 技术去自动分析 GitHub 仓库上的代码,自动给大家生成一份详细的文档,我看了看,确实写的非常 详细,还带有各种图表。
核心功能
- 自动文档:解释代码结构、函数和依赖关系。
- 交互式图表:如类层次结构和依赖图,帮助可视化代码。
- AI 聊天助手:基于 Devin 技术,回答关于仓库的具体问题。
- 深度查询:支持发现 bug、优化建议等复杂分析。
技术实力
见图一
据说,DeepWiki 已经分析了超过 400 亿行代码,涵盖了 30,000 多个仓库,耗费了 30 万美元的计算资源,能力很强大 。所以,一经推出,业界称它为“一个免费的 GitHub 仓库百科全书”。
使用方法
如果使用呢?方法很简单,都不需要注册就可以使用,而且提供了非常方便的转换方式,这进一步降低了使用门槛。
方法就是:对于任何公开的 GitHub 仓库,用户只需将 URL 中的 "github" 替换为 "deepwiki",即可立即帮你转换 成交互式文档。
实际案例
我举个例子,比如,我刚才在 GitHub 热榜上看到一个比较火的开源项目:
github.com/ocrmypdf/OCRmyPDF
这个开源项目的功能是为扫描的 PDF 文件添加 OCR 文本层,允许其进行搜索。
我这里将链接当中的 "github" 替换为 "deepwiki" ,链接就变成了:
deepwiki.com/ocrmypdf/OCRmyPDF
我们直接访问这个链接,就可以看到 OCRmyPDF 这个项目的详细文档了。
见图二
大家可以看看,关于 OCRmyPDF 这个开源项目的文档非常全面,侧边栏有概述介绍、核心架构、高级功能、部署选项等等 各种功能介绍。
甚至会帮你生成各种架构图和流程图来帮助你理解这个开源项目的核心代码以及功能。
见图三
更甚者,还支持代码问答:见图四
对于不同的地方可以直接问 AI ,有深度研究功能。
总结
我感觉 DeepWiki 的诞生,对于开发者和学习者都非常有帮助。
对于开发者开源项目,以后不用自己写文档了,将代码上传到 GitHub 之后,直接让 DeepWiki 帮你生成文档之后,复制 到 README 文件中就行了。
对于开源项目的学习者呢?看不懂开源代码的可以用 DeepWiki 来帮你生成文档,详细跟 DeepWiki 交流咨询就解决了。
大家可以去试一试。
这个创意非常赞,既解决了程序员不爱写文档的痛点,也降低了开源项目的学习门槛。