LLMCheatsheets.jl

LLMCheatsheets.jl

LLMCheatsheets.jl是一個 Julia 軟體包，透過從 GitHub 儲存庫建立備忘單，可以輕鬆、即時地向 AI 模型教授新軟體包和儲存庫。該工具彌合了人類可讀文件和人工智慧友好的知識表示之間的差距，允許與語言模型和人工智慧助理無縫整合。

預設情況下，我們會取得提供的儲存庫中的資料夾和檔案的子集，並使用 LLM 將它們匯總到單一備忘單。

特徵

• 從 GitHub 儲存庫即時產生備忘單。
• 透過總結程式碼和文件（或只是將所有原始文件整理成一個字串）來表示人工智慧友善的知識。
• 與語言模型和人工智慧助理輕鬆整合（只需將備忘單複製到提示中）。
• 支援任何套件並且比檢索增強生成（RAG）更容易啟動。

安裝

若要安裝 LLMCheatsheets.jl，請使用 Julia 套件管理器和儲存庫 URL（尚未註冊）：

 using Pkg
Pkg . add (url = " https://github.com/svilupp/LLMCheatsheets.jl " )

提示

如果您在存取 GitHub API 時遇到速率限制，您可以設定個人存取權杖並將其設定為環境變數GITHUB_API_KEY以將請求限制提高到每小時 5000 個。

快速入門

以下是如何使用 LLMCheatsheets.jl 為 GitHub 儲存庫建立備忘單的基本範例。

 using LLMCheatsheets

repo = GitHubRepo ( " https://github.com/svilupp/PromptingTools.jl " )
create_cheatsheet (repo; save_path = true );

使用save_path = true ，備忘單將儲存到目前工作目錄中的llm-cheatsheets資料夾中。

幕後發生了什麼事：

1. 掃描儲存庫：掃描儲存庫以尋找與repo.paths和repo.file_types相符的所有相關檔案。
2. 總結文件：每個文件都使用 LLM 進行總結。
3. 產生備忘單：將摘要組合起來產生綜合備忘單。

對於單獨產生檔案並自行處理它們的低階接口，請參閱examples/create_for_promptingtools.jl 。

有時您可能只想下載檔案而不對其進行匯總。您可以使用collect功能來做到這一點。

files_str = collect (repo)

files_str將是一個字串，其中所有掃描的檔案連接在一起。要在 ChatGPT 或 Claude.ai 中使用它，請使用clipboard功能將其複製到剪貼簿 - files_str|>clipboard 。

預設情況下，掃描和下載的檔案分別是repo.paths和repo.file_types 。

進階用法

自訂掃描路徑和檔案類型

預設情況下， repo.paths包括["src", "docs/src", "README.md"] ， repo.file_types包括[".jl", ".md"] 。您可以在建立GitHubRepo物件時自訂這些：

例如，新增資料夾examples和.txt檔案來自訂我們將總結的內容：

repo = GitHubRepo ( " https://github.com/username/repository " ; paths = [ " examples " , " README.md " ], file_types = [ " .jl " , " .md " , " .txt " ])

使用不同的LLM

您可以透過將model參數傳遞給函數來使用不同的 LLM。

 create_cheatsheet (repo; save_path = true , model = " gpt4om " )

新增特殊說明

您可以提供特殊指令來指導 AI 產生備忘單：

 create_cheatsheet (repo; special_instructions = " Focus on the data structures and their interactions. " )

使用 PromptingTools.jl 提問

您也可以簡單地從 PromptingTools.jl 匯出 ai* 函數，以便將它們與 LLMCheatsheets.jl 一起使用。

 using LLMCheatsheets
# Re-export aigenerate, pprint from PromptingTools
using LLMCheatsheets : aigenerate, pprint
# Or import PromptingTools directly
# using PromptingTools

repo = GitHubRepo ( " https://github.com/svilupp/PromptingTools.jl " ; paths = [ " docs/src " , " README.md " ])
files_str = collect (repo)

msg = aigenerate ( " Read through these files: $(files_str) nn Answer the question: What is the function for creating prompt templates? " )
pprint (msg)

 The function for creating prompt templates in the `PromptingTools.jl` package is `create_template`. This function allows you to define a prompt with placeholders and save it for later use. The syntax is:

```julia
create_template(; user=<user prompt>,
system=<system prompt>, load_as=<template name>)
```

This function generates a vector of messages, which you can use directly in the `ai*` functions. If you provide the `load_as` argument, it will also register the template in the template store,
allowing you to access it later using its name.

常見問題解答

我受到 LLM 提供者的費率限制

如果您受到 LLM 提供者的速率限制，您可以透過設定較低的數字（例如ntasks=5或ntasks=2 ）來減少create_cheatsheet中並發匯總任務的數量（取決於您的 API 層）。

我受到 GitHub API 的速率限制

設定個人存取權杖並將其設定為ENV["GITHUB_API_KEY"] 。它將自動載入到變數LLMCheatsheets.GITHUB_API_KEY 。

如何為 GitHub API 設定個人存取權杖？

您可以依照以下步驟為 GitHub API 設定個人存取權杖：

1. 前往您的 GitHub 設定。
2. 按一下“個人存取令牌”。
3. 按一下“產生新令牌”。

然後您可以將其設定為ENV["GITHUB_API_KEY"]或LLMCheatsheets.GITHUB_API_KEY 。

文件

有關使用 LLMCheatsheets.jl 的更多信息，請參閱文檔。

問題與支持

如果您遇到任何問題或有疑問，請在 GitHub 儲存庫上提出問題。