Code2prompt：探索高效代碼編輯新紀(jì)元的開源模型工具

UCloud小助手發(fā)布于2024-07-10 15:59 / 478人閱讀

項(xiàng)目介紹

Code2prompt 是一個(gè)命令行工具，能將你的代碼庫轉(zhuǎn)化為單一的大型語言模型（LLM）提示，結(jié)合源碼樹結(jié)構(gòu)，模板定制，以及令牌計(jì)數(shù)。它旨在簡化與高級(jí)上下文窗口模型如GPT或Claude的交互，助你在重寫代碼、查找bug、編寫文檔和實(shí)現(xiàn)新功能等方面提升效率。通過將你·的整個(gè)項(xiàng)目轉(zhuǎn)換為一個(gè)全面的、對(duì) AI 友好的提示，Code2Prompt 使你能夠充分利用 AI 的潛力進(jìn)行代碼分析、文檔和改進(jìn)任務(wù)。

項(xiàng)目應(yīng)用場景

代碼遷移：想把代碼從一種編程語言轉(zhuǎn)換到另一種？只需提供一個(gè)目標(biāo)語言的模板，讓LLM來完成任務(wù)。

錯(cuò)誤檢測：利用code2prompt生成的提示，讓LLM識(shí)別潛在的安全漏洞或編碼錯(cuò)誤。

文檔生成：自動(dòng)為代碼添加注釋，提高代碼可讀性。

性能優(yōu)化：通過調(diào)整代碼結(jié)構(gòu)，提高代碼執(zhí)行效率。

版本控制：基于git的變更，生成有意義的提交消息。

項(xiàng)目特點(diǎn)

整體代碼庫表示：生成一個(gè)結(jié)構(gòu)良好的 Markdown 提示，以捕捉整個(gè)項(xiàng)目的本質(zhì)。

智能源代碼樹生成：創(chuàng)建代碼庫結(jié)構(gòu)的清晰分層視圖。

可自定義的提示模板：使用 Jinja2 模板定制您的輸出以適應(yīng)特定的 AI 任務(wù)。

智能令牌管理：對(duì)令牌進(jìn)行計(jì)數(shù)和優(yōu)化，以確保與各種 LLM 令牌限制兼容。

Gitignore集成：尊重項(xiàng)目的 .gitignore 規(guī)則，以獲得準(zhǔn)確的表示。

靈活的文件處理：使用強(qiáng)大的 glob 模式過濾和排除文件。

剪貼板就緒：立即將生成的提示復(fù)制到剪貼板，以便進(jìn)行快速的 AI 交互。

增強(qiáng)的代碼可讀性：將行號(hào)添加到源代碼塊中，以便精確引用。

項(xiàng)目使用及實(shí)例

Code2Prompt 的基本語法為：

對(duì)于多條路徑：

命令參數(shù)

--filter或和或-f--exclude-e 和選項(xiàng)允許您分別指定應(yīng)包含在處理中或從處理中排除的文件或目錄的模式。--filter--exclude

語法

使用實(shí)例

從單個(gè) Python 文件生成提示：

處理整個(gè)項(xiàng)目目錄并保存輸出：

為多個(gè)文件生成提示，不包括測試：

Code2Prompt 中的令牌和配置文件

標(biāo)記是語言模型處理的文本的基本單位。它們可以是單詞、單詞的一部分，甚至是標(biāo)點(diǎn)符號(hào)。不同的分詞器編碼以不同的方式將文本拆分為分割令牌。Code2Prompt 通過其選項(xiàng)支持多種令牌類型，默認(rèn)為“cl100k_base”。GPT-3.5 和 GPT-4 等模型使用的這種編碼擅長處理代碼和技術(shù)內(nèi)容。其他常見的編碼包括“p50k_base”（由早期的 GPT-3 模型使用）和“r50k_base”（由 CodeX 等模型使用）。

若要在生成的提示中計(jì)算令牌，請(qǐng)使用以下標(biāo)志：