LLMCheatsheets.jl Télécharger - LLMCheatsheets.jl Téléchargement du code source

LLMCheatsheets.jl

Code Source AI

v0.1.0

Télécharger

LLMCheatsheets.jl

LLMCheatsheets.jl est un package Julia qui permet d'enseigner facilement et instantanément aux modèles d'IA les nouveaux packages et référentiels en créant des aide-mémoire à partir des référentiels GitHub. Cet outil comble le fossé entre la documentation lisible par l'homme et la représentation des connaissances conviviale pour l'IA, permettant une intégration transparente avec les modèles de langage et les assistants d'IA.

Par défaut, nous prenons un sous-ensemble de dossiers et de fichiers dans le référentiel fourni et les résumons à l'aide d'un LLM dans une seule aide-mémoire.

Caractéristiques

Génération instantanée de feuilles de triche à partir des référentiels GitHub.
Représentation des connaissances adaptée à l'IA en résumant le code et la documentation (ou simplement en rassemblant tous les fichiers bruts en une seule chaîne).
Intégration facile avec des modèles de langage et des assistants IA (copiez simplement l'aide-mémoire dans votre invite).
Prise en charge de n'importe quel package et plus facile à démarrer que Retrieval Augmented Generation (RAG).

Installation

Pour installer LLMCheatsheets.jl, utilisez le gestionnaire de packages Julia et l'URL du dépôt (il n'est pas encore enregistré) :

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

Conseil

Si vous rencontrez des limites de débit lors de l'accès à l'API GitHub, vous pouvez configurer un jeton d'accès personnel et le définir comme variable d'environnement GITHUB_API_KEY pour augmenter votre limite de requêtes à 5 000 par heure.

Démarrage rapide

Voici un exemple de base montrant comment utiliser LLMCheatsheets.jl pour créer une aide-mémoire pour un référentiel GitHub.

 using LLMCheatsheets

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

Avec save_path = true , l'aide-mémoire sera enregistrée dans le dossier llm-cheatsheets dans le répertoire de travail actuel.

Ce qui se passe dans les coulisses :

Analyse du référentiel : le référentiel est analysé pour trouver tous les fichiers pertinents correspondant repo.paths et repo.file_types .
Résumation des fichiers : chaque fichier est résumé à l'aide d'un LLM.
Génération d'une aide-mémoire : les résumés sont combinés pour générer une aide-mémoire complète.

Pour une interface de bas niveau permettant de générer les fichiers individuellement et de les traiter vous-même, voir examples/create_for_promptingtools.jl .

Parfois, vous souhaiterez peut-être simplement télécharger les fichiers sans les résumer. Vous pouvez le faire avec la fonction collect .

files_str = collect (repo)

files_str sera une chaîne avec tous les fichiers analysés concaténés ensemble. Pour l'utiliser dans ChatGPT ou Claude.ai, utilisez la fonctionnalité clipboard pour le copier dans le presse-papiers - files_str|>clipboard .

Par défaut, les fichiers analysés et téléchargés sont respectivement repo.paths et repo.file_types .

Utilisation avancée

Personnalisation des chemins analysés et des types de fichiers

Par défaut, repo.paths inclut ["src", "docs/src", "README.md"] et repo.file_types inclut [".jl", ".md"] . Vous pouvez les personnaliser lors de la création de l'objet GitHubRepo :

Par exemple, ajouter un dossier examples et des fichiers .txt pour personnaliser ce que nous allons résumer :

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

Utiliser un autre LLM

Vous pouvez utiliser un LLM différent en passant l'argument model aux fonctions.

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

Ajout d'instructions spéciales

Vous pouvez fournir des instructions spéciales pour guider l'IA dans la génération de l'aide-mémoire :

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

Utiliser PromptingTools.jl pour poser des questions

Vous pouvez simplement exporter également les fonctions ai* depuis PromptingTools.jl pour les utiliser avec 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.

Foire aux questions

Mon tarif est limité par les prestataires LLM

Si votre débit est limité par les fournisseurs LLM, vous pouvez réduire le nombre de tâches de synthèse simultanées dans create_cheatsheet en définissant un nombre inférieur comme ntasks=5 ou ntasks=2 (dépend de votre niveau d'API).

Mon débit est limité par l'API GitHub

Configurez un jeton d'accès personnel et définissez-le comme ENV["GITHUB_API_KEY"] . Il sera automatiquement chargé dans une variable LLMCheatsheets.GITHUB_API_KEY .