From 4c005caa33a0f917180fb77fd7cc0098722d575c Mon Sep 17 00:00:00 2001 From: xclicx <97340999+xclicx@users.noreply.github.com> Date: Sun, 17 Nov 2024 20:04:08 +0100 Subject: [PATCH 1/2] Update README_FR.md --- README_FR.md | 180 ++++++++++++++------------------------------------- 1 file changed, 47 insertions(+), 133 deletions(-) diff --git a/README_FR.md b/README_FR.md index b866bd5cdc6..b317bd4a094 100644 --- a/README_FR.md +++ b/README_FR.md @@ -2,170 +2,84 @@ Eliza Banner -## la fonctionnalité +## Fonctionnalités -- 🛠 soutenir la connexion discord/ twitter /telegram -- 👥 soutien aux agents multimodaux -- 📚 simple à importer des documents et interagir avec les documents -- mémoire et stockage des documents accessibles -- 🚀 haute scalabilité, vous pouvez personnaliser les clients et les comportements pour une extension fonctionnelle -- ☁ ️ plusieurs modèles, y compris Llama, OpenAI Grok Anthropic, etc. -- 📦 simple et facile à utiliser +- 🛠 Support des connecteurs Discord/ Twitter / Telegram +- 🔗 Support des différents modèles d'IA (Llama, Grok, OpenAI, Anthropic, etc.) +- 👥 Gestion de plusieurs agents et assistance +- 📚 Import et intéractions avec différents types de documents simplifiés +- 💾 Accès aux données en mémoire et aux documents stockés +- 🚀 Grande personnalisation possible : création de nouveaux clients et de nouvelles actions +- 📦 Simplicité d'utilisation Que pouvez-vous faire avec Eliza? -- 🤖 le chatbot -- 🕵 ️ Agents autonomes -- 📈 processus métier pour automatiser le traitement -- 🎮 jeux PNJ +- 🤖 Chatbot +- 🕵 ️Agents autonomes +- 📈 Processus automatisés +- 🎮 PNJ intéractifs +- 🧠 Trading automatisé -# commencez à utiliser -**pré-requis (obligatoire) :** +# Premiers pas +**Pré-requis (obligatoire) :** + +- [Python 2.7+](https://www.python.org/downloads/) - [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) -- installation Nodejs - [pnpm](https://pnpm.io/installation) -- travailler avec PNPM - -### éditer le fichier.env - -- copiez.env.example en.env et remplissez la valeur appropriée -- modifier l’environnement twitter et entrer votre compte twitter et mot de passe - -### modifier les fichiers de rôles - -- voir le document `src/core/defaultCharacter ts` - vous pouvez le modifier -- vous pouvez également utiliser `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json" ` et simultanément plusieurs robots. - -Après avoir terminé la configuration des fichiers de compte et de rôle, lancez votre bot en tapant la ligne de commande suivante: - -``` -pnpm i -pnpm start -``` -# personnalisez votre Eliza +> **Note pour Windows :** WSL est requis -### ajouter un comportement régulier +### Editer le fichier .env -Pour éviter les conflits Git dans le répertoire core, nous vous recommandons d’ajouter les actions personnalisées dans le répertoire custom_actions et de les configurer dans le fichier elizaconfig.yaml. Vous pouvez consulter l’exemple dans le fichier elizaconfig.example.yaml. +- Copier le fichier d'example et le remplir le avec les valeurs adéquates -## configurez différents grands modèles - -### configurer Llama - -Vous pouvez exécuter en définissant la variable d’environnement `XAI_MODEL` à `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct` Llama 70B ou 405B modèle - -### configurer OpenAI - -Vous pouvez exécuter le modèle OpenAI en définissant la variable d’environnement `XAI_MODEL` à `gpt-4o-mini` ou `gpt-4o` - -## autres demandes - -Vous devrez peut-être installer Sharp. Si vous voyez une erreur au démarrage, essayez d’installer avec la commande suivante: - -``` -pnpm install --include=optional sharp ``` - -# paramètres de l’environnement - -Vous devez ajouter des variables d’environnement à votre fichier.env pour vous connecter à différentes plates-formes: - +cp .env.example .env ``` -# Required environment variables -DISCORD_APPLICATION_ID= -DISCORD_API_TOKEN= # Bot token -OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk- -ELEVENLABS_XI_API_KEY= # API key from elevenlabs - -# ELEVENLABS SETTINGS -ELEVENLABS_MODEL_ID=eleven_multilingual_v2 -ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM -ELEVENLABS_VOICE_STABILITY=0.5 -ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 -ELEVENLABS_VOICE_STYLE=0.66 -ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false -ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 -ELEVENLABS_OUTPUT_FORMAT=pcm_16000 - -TWITTER_DRY_RUN=false -TWITTER_USERNAME= # Account username -TWITTER_PASSWORD= # Account password -TWITTER_EMAIL= # Account email -TWITTER_COOKIES= # Account cookies -X_SERVER_URL= -XAI_API_KEY= -XAI_MODEL= +### Modifier les fichiers personnage +1. Ouvrir le document `src/core/defaultCharacter.ts` afin de modifier le personnage par défaut -# For asking Claude stuff -ANTHROPIC_API_KEY= +2. Pour ajouter des personnages personnalisés : + - Lancer la commande `pnpm start --characters="path/to/your/character.json"` + - Plusieurs fichiers personnages peuvent être ajoutés en même temps -WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY -WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY +### Lancer Eliza -BIRDEYE_API_KEY= +Après avoir terminé la configuration et les fichiers personnage, lancer le bot en tapant la ligne de commande suivante: -SOL_ADDRESS=So11111111111111111111111111111111111111112 -SLIPPAGE=1 -RPC_URL=https://api.mainnet-beta.solana.com -HELIUS_API_KEY= - - -## Telegram -TELEGRAM_BOT_TOKEN= +```bash +pnpm i +pnpm build +pnpm start -TOGETHER_API_KEY= +# Le projet étant régulièrement mis à jour, il vous faudra parfois le nettoyer avant de recommencer à travailler dessus +pnpm clean ``` -# paramètres locaux - -### ensemble CUDA +#### Ressources additionelles -Si vous avez une carte graphique nvidia haute performance, vous pouvez faire l’accélération locale avec la ligne de commande suivante CUDA +Il vous faudra peut-être installer Sharp. +Si il y a une erreur lors du lancement du bot, essayez d'installer Sharp comme ceci : ``` -pnpm install -npx --no node-llama-cpp source download --gpu cuda +pnpm install --include=optional sharp ``` -Assurez-vous d’avoir le kit complet CUDA installé, y compris cuDNN et cuBLAS - -### exécution locale +### Communauté et réseaux sociaux -Ajoutez XAI_MODEL et définissez-le à l’une des options ci-dessus [use Llama run](#run-with-llama) -Vous pouvez laisser X_SERVER_URL et XAI_API_KEY vides, qui téléchargera le modèle de huggingface et le consultera localement +- [GitHub](https://github.com/ai16z/eliza/issues). Pour partager les bugs découverts lors de l'utilisation d'Eliza, et proposer de nouvelles fonctionnalités. +- [Discord](https://discord.gg/ai16z). Pour partager ses applications et rencontrer la communauté. -# le client - -Pour savoir comment configurer votre bot discord, vous pouvez consulter la documentation officielle de discord - -# le développement - -## le test - -Ligne de commande pour plusieurs méthodes de test: - -```bash -pnpm test # Run tests once -pnpm test:watch # Run tests in watch mode -``` - -Pour les tests spécifiques à la base de données: - -```bash -pnpm test:sqlite # Run tests with SQLite -pnpm test:sqljs # Run tests with SQL.js -``` +## Contributeurs -Les tests sont écrits en Jest et se trouvent dans le fichier SRC /\*_/_.test.ts. L’environnement de test est configuré comme suit: + + + -- chargement des variables d’environnement de.env.test -- utilisez un temps d’attente de 2 minutes pour exécuter des tests de longue durée -- support du module ESM -- exécuter les tests dans l’ordre (--runInBand) +## Historique d'étoiles -Pour créer un nouveau test, ajoutez un fichier.test.ts à côté du code à tester. +[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date) From 0d433d1f427254541c9ab7e15763a9df4a18174c Mon Sep 17 00:00:00 2001 From: xclicx <97340999+xclicx@users.noreply.github.com> Date: Sun, 17 Nov 2024 20:32:02 +0100 Subject: [PATCH 2/2] Create README_FR.md --- docs/README_FR.md | 181 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 181 insertions(+) create mode 100644 docs/README_FR.md diff --git a/docs/README_FR.md b/docs/README_FR.md new file mode 100644 index 00000000000..e02f71c0dad --- /dev/null +++ b/docs/README_FR.md @@ -0,0 +1,181 @@ +# Eliza + +Eliza Banner + +_Utilisée dans [@DegenSpartanAI](https://x.com/degenspartanai) et [@MarcAIndreessen](https://x.com/pmairca)_ + +- Outil de simulation de multiples agents +- Ajout de multiples personnages avec [characterfile](https://github.com/lalalune/characterfile/) +- Support des fonctionnalités et connecteurs Discord/ Twitter / Telegram, avec salons vocaux sur Discord +- Accès aux données en mémoire et aux documents stockés +- Peut ouvrir et lire des documents PDF, retranscire des fichiers son et vidéo, résumer des conversations, etc. +- Supporte les modèles open source et locaux (configuré par défaut avec Nous Hermes Llama 3.1B) +- Supporte OpenAI pour une utilisation sur le cloud depuis une machine peu performante +- Mode "Ask Claude" pour l'utilisation de Claude sur des modèles complexes +- 100% Typescript + +# Premiers pas + +**Pré-requis (obligatoire) :** + +- [Python 2.7+](https://www.python.org/downloads/) +- [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- [pnpm](https://pnpm.io/installation) + +### Edit the .env file + +- Copy .env.example to .env and fill in the appropriate values +- Edit the TWITTER environment variables to add your bot's username and password + +### Modifier les fichiers personnage + +1. Ouvrir le document `src/core/defaultCharacter.ts` afin de modifier le personnage par défaut + +2. Pour ajouter des personnages personnalisés : + - Lancer la commande `pnpm start --characters="path/to/your/character.json"` + - Plusieurs fichiers personnages peuvent être ajoutés en même temps + +### Lancer Eliza + +Après avoir terminé la configuration et les fichiers personnage, lancer le bot en tapant la ligne de commande suivante: + +```bash +pnpm i +pnpm build +pnpm start + +# Le projet étant régulièrement mis à jour, il vous faudra parfois le nettoyer avant de recommencer à travailler dessus +pnpm clean +``` + +# Personnaliser Eliza + +### Ajouter un des actions personnalisées + +Pour éviter les conflits Git dans le répertoire core, nous vous recommandons d’ajouter les actions personnalisées dans un répertoire `custom_actions` et de les configurer dans le fichier `elizaConfig.yaml` . Vous pouvez consulter l’exemple dans le fichier `elizaConfig.example.yaml`. + +## Utiliser les différents modèles + +### Lancer avec Llama + +Vous pouvez exécuter le modèle Llama 70B ou 405B en définissant la variable d’environnement `XAI_MODEL` avec la valeur `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct` + +### Lancer avec Grok + +Vous pouvez exécuter le modèle Grok en définissant la variable d’environnement `XAI_MODEL` avec la valeur `grok-beta` + +### Lancer avec OpenAI + +Vous pouvez exécuter le modèle OpenAI en définissant la variable d’environnement `XAI_MODEL` avec la valeur `gpt-4o-mini` ou `gpt-4o` + +## Ressources additionnelles + +Il vous faudra peut-être installer Sharp. +Si il y a une erreur lors du lancement du bot, essayez d'installer Sharp comme ceci : + +``` +pnpm install --include=optional sharp +``` + +# Paramètres + +Vous devez ajouter certaines variables à votre fichier .env pour vous connecter aux différentes plates-formes: + +``` +# Variables d'environement Discord (nécessaires) +DISCORD_APPLICATION_ID= +DISCORD_API_TOKEN= # Bot token +OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk- +ELEVENLABS_XI_API_KEY= # API key from elevenlabs + +# Parmètres ELEVENLABS +ELEVENLABS_MODEL_ID=eleven_multilingual_v2 +ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM +ELEVENLABS_VOICE_STABILITY=0.5 +ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 +ELEVENLABS_VOICE_STYLE=0.66 +ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false +ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 +ELEVENLABS_OUTPUT_FORMAT=pcm_16000 + +TWITTER_DRY_RUN=false +TWITTER_USERNAME= # Account username +TWITTER_PASSWORD= # Account password +TWITTER_EMAIL= # Account email +TWITTER_COOKIES= # Account cookies + +X_SERVER_URL= +XAI_API_KEY= +XAI_MODEL= + + +# Pour interagir avec Claude +ANTHROPIC_API_KEY= + +WALLET_SECRET_KEY=EXAMPLE_WALLET_SECRET_KEY +WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY + +BIRDEYE_API_KEY= + +SOL_ADDRESS=So11111111111111111111111111111111111111112 +SLIPPAGE=1 +RPC_URL=https://api.mainnet-beta.solana.com +HELIUS_API_KEY= + + +## Telegram +TELEGRAM_BOT_TOKEN= + +TOGETHER_API_KEY= +``` + +# Utilisation en local + +### Suite CUDA + +Si vous avez une carte graphique NVIDIA, vous pouvez installer CUDA afin de grandement améliorer les performances : + +``` +pnpm install +npx --no node-llama-cpp source download --gpu cuda +``` + +Assurez-vous d’avoir le kit complet CUDA installé, y compris cuDNN et cuBLAS. + +### Exécution locale + +Ajoutez XAI_MODEL et définissez-le à l’une des options ci-dessus [Run with +Llama](#run-with-llama) - Vous pouvez laisser les valeurs X_SERVER_URL et XAI_API_KEY vides, le modèle est sera téléchargé depuis huggingface et sera modifié en local + +# Clients + +## Bot Discord + +Pour savoir comment configurer votre bot Discord, vous pouvez consulter la documentation officielle de Discord : https://discordjs.guide/preparations/setting-up-a-bot-application.html + +# Développement + +## Tests + +Ligne de commande pour lancer les tests : + +```bash +pnpm test # Lance les tests +pnpm test:watch # Lance les tests en mode observation +``` + +Pour les tests spécifiques à la base de données : + +```bash +pnpm test:sqlite # Lance les tests avec SQLite +pnpm test:sqljs # Lance les tests avec SQL.js +``` + +Les tests sont écrits en Jest et se trouvent ici : `src/**/*.test.ts`. L’environnement de test est configuré pour : + +- Charger les variables d’environnement depuis `.env.test` +- Ajouter d'un délai d'attente de 2 minutes pour les tests de longue durée +- Supporter les modules ESM +- Lancer les tests de façon séquentielle (--runInBand) + +Pour créer un nouveau test, ajoutez un fichier `.test.ts` à côté du code à tester.