codequestion

codequestion

专为开发者设计的离线语义搜索工具

codequestion是一款使用Stack Exchange数据和Python 3.8+的本地语义搜索应用。无需网络连接,即可快速查找相似问题,并集成txtai 5.0,提供语义图和路径遍历功能。支持VS Code集成和API服务,安装简便,适用于各种平台。

codequestion开发者语义搜索模型下载安装指南Github开源项目

项目介绍:codequestion

codequestion 是一个专为开发者设计的语义搜索应用。它帮助开发者在本地环境中寻找与输入问题相似的开发相关问题,从而减少对网络搜索的依赖。以下是该项目的详细介绍。

项目概述

开发人员在工作时经常需要在浏览器中查找问题,而 codequestion 让这一过程更为简单和本地化。通过执行相似度查询,codequestion 可以在本地查找与输入问题相似的问题,这样开发者不必每次都在网上搜索。

codequestion 的默认模型基于 Stack Exchange 在 archive.org 上的公开数据构建。一旦安装了模型,用户即可离线使用,不需要网络连接进行查询。

技术细节

codequestion 使用 Python 3.8+ 开发,并整合了 txtai 做为其底层技术。这一项目可以通过以下步骤轻松安装并开始使用。

安装指南

要安装 codequestion,最简单的方法是通过 pip 和 PyPI:

pip install codequestion

推荐使用 Python 虚拟环境,以保障不同项目之间的依赖隔离。

如需访问最新的、尚未发布的功能,可以直接从 GitHub 安装:

pip install git+https://github.com/neuml/codequestion

模型下载

安装完成后,需下载所需的模型:

python -m codequestion.download

下载的模型将存储在 ~/.codequestion/ 目录下。如果没有直接的网络连接,也可以手动安装模型,默认的模型可以从 GitHub 发布页面中获取。

搜索使用

启动 codequestion 后,可以在 shell 中键入查询。在控制台输入 help 来查看所有可用命令。

主题和路径遍历

最新版本的 codequestion 集成了 txtai 5.0,支持语义图。通过语义图,可以进行主题建模和路径遍历。例如,可以查看两个可能完全无关联的条目如何通过语义图连接起来。

在 VS Code 中使用

在 Visual Studio Code 中,用户可以启动 codequestion 的提示框,直接从 IDE 中提出编程问题。按下 Ctrl+` 可以开启一个新的终端并输入 codequestion 启动搜索。

API 服务

codequestion 构建了一个标准的 txtai 嵌入索引,因此支持通过 txtai API 服务托管该索引。开发者可以配置一个 app.yml 文件来开启 API 服务,并通过 curl 命令测试 API 的搜索功能。

技术概述

数据处理

Stack Exchange 的 7z XML 原始数据经过多步骤处理,仅选取评分较高且有公认答案的问题存储到模型中。这些问题和答案被整合到一个名为 questions.db 的 SQLite 文件中。

建立索引

questions.db 中的每个问题构建 txtai 嵌入索引,使用一种句子变换模型为其向量化。全部转换完成后,这些嵌入将被存储在 Faiss 系统里,支持快速搜索。

查询处理

codequestion 使用与索引用相同的方法将每次查询令牌化,并将其转化为句子嵌入。通过 Faiss 索引来查找最相似的问题。

模型的构建

构建 codequestion 模型实际上包括从 Stack Exchange 下载数据,执行 ETL 过程,最终生成可被查询的索引。以下步骤涵盖了这一过程:

  1. archive.org 下载 Stack Exchange 数据。
  2. 在本地设置目录结构并运行 ETL 过程。
  3. 选择性地构建词向量模型(如有需要)。
  4. 使用一个 index.yml 文件建立嵌入索引。

模型准确性

为评估模型的性能,使用了 Mean Reciprocal Rank (MRR)Pearson Correlation 衡量其在最新的 Stack Exchange 数据下的表现。

测试

可以在本地通过以下命令重现模型测试结果:

mkdir -p $TEST_PATH wget https://raw.githubusercontent.com/neuml/codequestion/master/test/stackexchange/query.txt -P $TEST_PATH/stackexchange wget http://ixa2.si.ehu.es/stswiki/images/4/48/Stsbenchmark.tar.gz tar -C $TEST_PATH -xvzf Stsbenchmark.tar.gz python -m codequestion.evaluate -s test -p $TEST_PATH

通过以上的描述和指引,开发者可以快速上手并体验 codequestion 带来的便利。它的本地搜索能力和嵌入技术的结合,使其成为开发者手头的强大工具。

编辑推荐精选

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

下拉加载更多