Créez un environnement de développement.

Avant d’effectuer toute modification de code, il est essentiel de mettre en place l’environnement nécessaire au développement de Xinference. Cela inclut la maîtrise de l’utilisation de Git, la création d’un environnement indépendant, l’installation de Xinference ainsi que la compilation de la partie front-end.

Utilisation de Git

Lorsque vous avez un problème à corriger, une fonctionnalité à ajouter ou une documentation à améliorer, il est important de vous familiariser avec GitHub et la base de code de Xinference.

Pour les nouveaux utilisateurs, utiliser Git est l’un des aspects les plus intimidants de la participation au développement de Xinference. On peut rapidement se sentir submergé, mais le guide suivant aidera à simplifier le processus et à réduire les problèmes potentiels. Si vous rencontrez des difficultés que vous ne parvenez pas à résoudre, n’hésitez pas à demander de l’aide dans la communauté.

Le code de Xinference est hébergé sur GitHub. Pour contribuer au code de Xinference, vous devez créer un compte GitHub gratuit. Nous utilisons Git pour le contrôle de version, afin que chacun puisse participer au développement du projet.

Vous pouvez vous référer au Guide GitHub pour installer git, configurer les clés SSH ainsi que paramétrer git. Vous devez accomplir ces étapes pour garantir que votre dépôt local et GitHub fonctionnent correctement, afin que les travaux ultérieurs puissent se dérouler sans problème.

Voici quelques excellentes ressources pour apprendre Git :

• Documentation officielle de Git

• Livre Pro Git

• Tutoriel Git fourni par Atlassian

• Guide succinct de Git

Note

Si la vitesse est lente lors du git clone du code, vous pouvez ajouter un proxy avec la commande suivante :

export https_proxy=YourProxyAddress

Créez un environnement isolé.

Avant d’installer officiellement Xinference, il est recommandé d’utiliser Conda pour créer un environnement isolé afin de faciliter les opérations ultérieures.

conda create --name xinf
conda activate xinf

xinf peut être remplacé par un nom d’environnement Conda personnalisé.

Installez ensuite Python et Node.js (npm) dans l’environnement Conda nouvellement créé. La commande est la suivante :

conda install python=3.12
conda install nodejs

Installer à partir du code source

Avant de commencer, assurez-vous d’avoir cloné le dépôt. Supposons que vous ayez cloné le dépôt dans un répertoire nommé inference, accédez à ce répertoire, qui contient les fichiers setup.cfg et setup.py, puis exécutez la commande suivante :

pip install -e .
xinference-local

Si la commande s’exécute avec succès, vous pourrez ensuite utiliser Xinference normalement. Pour un tutoriel détaillé, veuillez consulter Utilisation.

Si une erreur apparaît ou si le processus se bloque pendant l’exécution, il est alors nécessaire de procéder à l’étape suivante de la compilation du front-end.

Compilation frontale

Tout d’abord, il faut entrer dans le répertoire inference/xinference/ui/web/ui, puis exécuter la commande suivante pour vider le cache :

npm cache clean

Si l’exécution de la commande échoue, vous pouvez essayer d’ajouter l’option --force.

Note

S’il existe déjà un dossier node_modules dans ce répertoire, il est recommandé de le supprimer manuellement au préalable.

Exécutez ensuite la commande suivante dans ce répertoire pour la compilation du front-end :

npm install
npm run build

Si la première commande échoue, vous pouvez toujours essayer de résoudre le problème en ajoutant l’option --force.

Après avoir compilé le frontend, vous pouvez revenir au répertoire contenant les fichiers setup.cfg et setup.py, puis installer Xinference via pip install -e ..