还在为理解企业级代码库而苦恼吗？

理解复杂的代码库是软件工程中普遍存在的挑战。无论是深入遗留系统、探索开源项目，还是加入新团队，理解大型代码库都可能耗时且费力。今天，我们很高兴推出 KnowLang，一款开源工具，通过语义搜索和智能问答功能，让代码库更易于理解。

为什么选择 KnowLang？

尽管大型语言模型（LLMs）已经彻底改变了代码理解，但现有解决方案通常在以下方面遇到困难：

• 缺乏对机密或最新代码的感知
• 提供具有适当上下文的准确答案
• 回答存储库间的依赖关系问题

KnowLang 通过以下方式解决了这些挑战：

1. 智能代码分块，保留语义含义
2. 结合嵌入和摘要的高级检索技术
3. 引用特定代码段的上下文感知响应

工作原理

KnowLang 使用两阶段流程来处理代码库并与之交互。

阶段1：代码处理流程

代码处理流程：

1. 克隆并识别相关文件
2. 使用 Tree-sitter 进行稳健解析
3. 智能地分块代码，同时保留上下文
4. 生成摘要和嵌入
5. 存储在向量数据库中以实现高效检索

阶段2：查询流程

示例：理解 Hugging Face Transformers

让我们使用 KnowLang 来探索 Hugging Face Transformers 库。以下是一个示例交互：

用户问题：

实现一个新的量化方法需要哪些关键组件？

KnowLang 回答：

根据提供的代码上下文，要实现一个新的量化方法，你需要创建一个继承自 HfQuantizer 的新类，并实现以下关键组件：

1. 必需的类属性:

• requires_calibration: 布尔值，指示是否需要校准
• required_packages: 所需 pip 包的列表
• requires_parameters_quantization: 布尔值，指示是否需要创建新参数

2. 强制抽象方法（必须实现）

• _process_model_before_weight_loading(self, model, **kwargs): 用于在加载权重之前预处理模型
• _process_model_after_weight_loading(self, model, **kwargs): 用于在加载权重之后后处理模型
• is_serializable(self, safe_serialization=None): 定义序列化行为

3. 关键方法重写:

• validate_environment(self, *args, **kwargs): 检查所需的依赖项和潜在冲突
• update_torch_dtype(self, torch_dtype): 处理特定的 dtype 要求
• check_quantized_param(self, model, param_value, param_name, state_dict, **kwargs): 如果需要参数量化

4. 配置:

• 构造函数中必须接受一个 quantization_config，用于定义量化参数。

这可以在 QuantoHfQuantizer 和 AqlmHfQuantizer 类的实现示例中看到，它们遵循此模式。例如，在 QuantoHfQuantizer 中（第1-10行）

class QuantoHfQuantizer(HfQuantizer):
    required_packages = ["quanto", "accelerate"]
    requires_parameters_quantization = True
    requires_calibration = False

    def __init__(self, quantization_config: QuantoConfig, **kwargs):
        super().__init__(quantization_config, **kwargs)

性能和评估

在代码聚焦的 RAG 系统中，一个重要的挑战是缺乏标准化的评估方法。传统指标往往无法捕捉代码理解所需的细微差别。KnowLang 采取了一种新颖的方法，利用 LLM 本身作为评估器。目前，我们的评估框架采用 GPT-4 和 Claude 3.5 Sonnet 来评估三个关键维度：

• 分块相关性（7.19/10）：检索到的代码块与查询的匹配程度
• 答案正确性（6.05/10）：生成响应的准确性和完整性
• 代码引用（5.9/10）：源代码的正确归属和上下文使用

通过这种自动化评估过程，我们发现了几个有趣的见解：

• 在分块中添加代码摘要改善了所有指标的整体性能
• 令人惊讶的是，仅使用嵌入的方法在代码检索方面优于更复杂的重排序策略。
• 不同的嵌入模型表现出意想不到的性能差异，较小的模型有时甚至优于较大的模型。这表明针对特定用途训练的模型比通用模型更强大。

尽管这些早期结果很有前景，但我们承认基于 LLM 的评估仍是一个新兴领域。我们正在积极努力提高评估框架的可靠性和可复现性。

未来方向

我们正在积极致力于：

1. 跨存储库语义搜索
2. 支持更多编程语言
3. 自动文档维护
4. IDE 集成

试用

KnowLang 是开源的，可在 GitHub 上获取。你可以：

• 在我们的 Hugging Face Space 中尝试演示
• 通过 pip 安装：pip install knowlang
• 访问我们的 GitHub 仓库

加入社区

我们相信社区驱动开发的强大力量。你可以通过以下方式贡献：

• 试用 KnowLang 并提供反馈
• 提出问题或提交拉取请求

结论

理解复杂的代码库不应该是软件开发的瓶颈。KnowLang 旨在通过 LLM 的强大功能和先进的检索技术，使代码理解更易于获取和高效。

我们很高兴看到社区如何使用和改进 KnowLang。快来试试吧，告诉我们你的想法！