[i18n-FR] Translated files in french and reviewed them (#2024)

* Translated toctree & git_vs_htttp * Translated the cli guide * Testing to see if user is well configured * TEsting to see if branch is well configured * Translated index * Translated quick-start * Corrected a minor error in the english doc * Reverting a wrong change * Translated installation.md * Translated community.md * Translated download.md * Translated hf_file_system.md * Translated inference_client * Translated inference_endpoints.md * Fixed a few errors in the translation * Translated integrations.md * Translated mana-cache.md. Did not find a good translfation for cache-system * Translated manage-space.md * Translated overview.md * Translated package-reference file * Translated hf_api, login, mixins, repository, space_runtime and tensorboard in the package reference * Finished the translation of package reference by translating utilities and webhooks servers * Translated model-cards.md * Translated collections.md * translated community.md * Translated download.md, corrected an error in the english version and changed a n inacurrate translation in other files * translated hf_file_system * Translated inference_endpoints.md * Translated inference.md * translated repository.md * Translated search.md * Translated webhooks_server.md * corrected webhooks * Translated upload.md * Added "fr" to .github/workflow * Deleted redirects as it is not needed * Corrected toctree.yml * Corrected errors o quick-start.md * Corrected installation.md * Changed the translation of the product "space" in the whole documentation. * Corrected git_vs_http * Corrected CLI.md * Corrected collections.md * Corrected community.md * Corrected download.md * Corrected hf_file_system * Correction of docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Corrected git vs http and index.md * Finished correcting index.md * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/installation.md Co-authored-by: Lucain <[email protected]> * Finished correcting index.md * Deleted all unchecked files * Update download.md * Corrected inference endpoint, a lot of mistakes might have to look at it again * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/_toctree.yml Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Deleted files that have not been reviewed yet * Deleted useless links in toctree * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Rechecked and corrected all typos signaled in the first PR, an error while merging probably caused this * Re checked and resolved typos for the previous PR * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Update docs/source/fr/concepts/git_vs_http.md Co-authored-by: Lucain <[email protected]> * Resolved typos showed in the recent conversation * Apply suggestions from code review * Update docs/source/fr/_toctree.yml * Apply suggestions from code review * Update docs/source/fr/_toctree.yml --------- Co-authored-by: JibrilEl <[email protected]> Co-authored-by: Lucain <[email protected]>
huggingface · Feb 20, 2024 · e05fb73 · e05fb73
1 parent d01206d
commit e05fb73
Show file tree

Hide file tree

Showing 7 changed files with 465 additions and 2 deletions.
diff --git a/.github/workflows/build_documentation.yaml b/.github/workflows/build_documentation.yaml
@@ -13,6 +13,6 @@ jobs:
     with:
       commit_sha: ${{ github.sha }}
       package: huggingface_hub
-      languages: cn de en hi ko
+      languages: cn de fr en hi ko
     secrets:
       hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
diff --git a/.github/workflows/build_pr_documentation.yaml b/.github/workflows/build_pr_documentation.yaml
@@ -14,4 +14,4 @@ jobs:
       commit_sha: ${{ github.event.pull_request.head.sha }}
       pr_number: ${{ github.event.number }}
       package: huggingface_hub
-      languages: cn de en hi ko
+      languages: cn de fr en hi ko
diff --git a/docs/source/fr/_toctree.yml b/docs/source/fr/_toctree.yml
@@ -0,0 +1,12 @@
+- title: "Introduction"
+  sections:
+    - local: index
+      title: Home
+    - local: quick-start
+      title: Démarrage rapide
+    - local: installation
+      title: Installation
+- title: "Concepts"
+  sections:
+    - local: concepts/git_vs_http
+      title: Git ou HTTP?
diff --git a/docs/source/fr/concepts/git_vs_http.md b/docs/source/fr/concepts/git_vs_http.md
@@ -0,0 +1,67 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
+# Git ou HTTP?
+
+`huggingface_hub` est une librairie qui permet d'interagir avec le Hugging Face Hub,
+qui est une collection de dépots Git (modèles, datasets ou spaces).
+Il y a deux manières principales pour accéder au Hub en utilisant `huggingface_hub`.
+
+La première approche, basée sur Git, appelée approche "git-based", est rendue possible par la classe [`Repository`].
+Cette méthode utilise un wrapper autour de la commande `git` avec des fonctionnalités supplémentaires conçues pour interagir avec le Hub. La deuxième option, appelée approche "HTTP-based" , consiste à faire des requêtes HTTP en utilisant le client [`HfApi`]. Examinons
+les avantages et les inconvénients de ces deux méthodes.
+
+## Repository: l'approche historique basée sur git
+
+Initialement, `huggingface_hub` était principalement construite autour de la classe [`Repository`]. Elle fournit des
+wrappers Python pour les commandes `git` usuelles, telles que `"git add"`, `"git commit"`, `"git push"`,
+`"git tag"`, `"git checkout"`, etc.
+
+Cette librairie permet aussi de gérer l'authentification et les fichiers volumineux, souvent présents dans les dépôts Git de machine learning. De plus, ses méthodes sont exécutables en arrière-plan, ce qui est utile pour upload des données durant l'entrainement d'un modèle.
+
+L'avantage principal de l'approche [`Repository`] est qu'elle permet de garder une
+copie en local du dépot Git sur votre machine. Cela peut aussi devenir un désavantage,
+car cette copie locale doit être mise à jour et maintenue constamment. C'est une méthode
+analogue au développement de logiciel classique où chaque développeur maintient sa propre copie locale
+et push ses changements lorsqu'il travaille sur une nouvelle fonctionnalité.
+Toutefois, dans le contexte du machine learning la taille des fichiers rend peu pertinente cette approche car
+les utilisateurs ont parfois besoin d'avoir
+uniquement les poids des modèles pour l'inférence ou de convertir ces poids d'un format à un autre sans avoir à cloner
+tout le dépôt.
+
+<Tip warning={true}>
+
+[`Repository`] est maintenant obsolète et remplacée par les alternatives basées sur des requêtes HTTP. Étant donné son adoption massive par les utilisateurs,
+la suppression complète de [`Repository`] ne sera faite que pour la version `v1.0`.
+
+</Tip>
+
+## HfApi: Un client HTTP plus flexible
+
+La classe [`HfApi`] a été développée afin de fournir une alternative aux dépôts git locaux,
+qui peuvent être encombrant à maintenir, en particulier pour des modèles ou datasets volumineux.
+La classe [`HfApi`]  offre les mêmes fonctionnalités que les approches basées sur Git,
+telles que le téléchargement et le push de fichiers ainsi que la création de branches et de tags, mais sans
+avoir besoin d'un fichier local qui doit être constamment synchronisé.
+
+En plus des fonctionnalités déjà fournies par `git`, La classe [`HfApi`] offre des fonctionnalités
+additionnelles, telles que la capacité à gérer des dépôts, le téléchargement des fichiers
+dans le cache (permettant une réutilisation), la recherche dans le Hub pour trouver
+des dépôts et des métadonnées, l'accès aux fonctionnalités communautaires telles que, les discussions,
+les pull requests et les commentaires.
+
+## Quelle méthode utiliser et quand ?
+
+En général, **l'approche HTTP est la méthode recommandée** pour utiliser `huggingface_hub`
+[`HfApi`] permet de pull et push des changements, de travailler avec les pull requests, les tags et les branches, l'interaction avec les discussions
+et bien plus encore. Depuis la version `0.16`, les méthodes HTTP-based peuvent aussi être exécutées en arrière-plan, ce qui constituait le
+dernier gros avantage  de la classe [`Repository`].
+
+Toutefois, certaines commandes restent indisponibles en utilisant [`HfApi`].
+Peut être que certaines ne le seront jamais, mais nous essayons toujours de réduire le fossé entre ces deux approches.
+Si votre cas d'usage n'est pas couvert, nous serions ravis de vous aider. Pour cela, ouvrez 
+[une issue sur Github](https://github.com/huggingface/huggingface_hub)! Nous écoutons tous les retours nous permettant de construire
+l'écosystème 🤗 avec les utilisateurs et pour les utilisateurs.
+
+Cette préférence pour l'approche basée sur [`HfApi`] plutôt que [`Repository`] ne signifie pas que les dépôts stopperons d'être versionnés avec git sur le Hugging Face Hub. Il sera toujours possible d'utiliser les commandes `git` en local lorsque nécessaire.
diff --git a/docs/source/fr/index.md b/docs/source/fr/index.md
@@ -0,0 +1,60 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
+# Un client Python pour le Hugging Face Hub 
+
+
+La librairie `huggingface_hub` vous permet d'interagir avec le
+[Hugging Face Hub](https://hf.co), une plateforme de machine learning
+pour créer et collaborer. Découvrez des modèles pré-
+entrainés et des datasets pour vos projets ou jouez avec des centraines
+d'applications hébergées sur le Hub. Vous pouvez aussi
+créer et partager vos propres modèles et datasets avec la communauté.
+La librairie `huggingface_hub` offre une manière simple de faire toutes
+ces choses avec Python.
+
+Lisez le [guide d'introduction rapide](quick-start) pour vous lancer avec la librairie
+`huggingface_hub`. Vous apprendrez à télécharger des fichiers depuis le Hub,
+à créer un dépôt et upload des fichiers vers le Hub. Continuez à lire pour
+apprendre le management de dépôt sur le Hub, comment interagir avec les discussions
+ou même comment accéder à l'API d'inférence.
+
+<div class="mt-10">
+  <div class="w-full flex flex-col space-y-4 md:space-y-0 md:grid md:grid-cols-2 md:gap-y-4 md:gap-x-5">
+
+    <a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./guides/overview">
+      <div class="w-full text-center bg-gradient-to-br from-indigo-400 to-indigo-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Vue d'ensemble</div>
+      <p class="text-gray-700">Guides pratiques pour vous aider à atteindre un but en particulier. Lisez ces guides pour apprendre comment utiliser huggingface_hub pour résoudre des problèmes concrets.</p>
+    </a>
+
+    <a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./package_reference/overview">
+      <div class="w-full text-center bg-gradient-to-br from-purple-400 to-purple-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Références</div>
+      <p class="text-gray-700">Description exhaustive des classes et méthodes présentes dans huggingface_hub.</p>
+    </a>
+
+    <a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./concepts/git_vs_http">
+      <div class="w-full text-center bg-gradient-to-br from-pink-400 to-pink-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Guides conceptuels</div>
+      <p class="text-gray-700">Explications permettant d'avoir une meilleure compréhension de la philosophie derrière huggingface_hub.</p>
+    </a>
+
+  </div>
+</div>
+
+<!-- 
+<a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-lg" href="./tutorials/overview"
+  ><div class="w-full text-center bg-gradient-to-br from-blue-400 to-blue-500 rounded-lg py-1.5 font-semibold mb-5 text-white text-lg leading-relaxed">Tutoriaux</div>
+  <p class="text-gray-700">Apprenez les bases et familiarisez vous avec l'utilisation de huggingface_hub pour intéragir avec le Hub 🤗 depuis le code!</p>
+</a> -->
+
+## Contributions
+
+Toutes les contributions au projet `huggingface_hub` sont les bienvenues et valorisées à la même hauteur.
+🤗 En plus de l'ajout ou de la correction de bug dans le code, vous
+pouvez également aider à améliorer la documentation en vérifiant qu'elle est exacte et
+à jour, répondre à des questions sur des issues, et demander de nouvelles fonctionnalités
+qui amélioreront la librairie. Regardez le [guide de contribution](https://github.com/huggingface/huggingface_hub/blob/main/CONTRIBUTING.md)
+pour en savoir plus sur comment commencer à travailler sur une issue, comment faire une pull request et comment tester vos contributions pour
+vérifier que vos modifications fonctionnent comme prévu.
+
+Les contributeurs doivent aussi respecter notre [code de conduite](https://github.com/huggingface/huggingface_hub/blob/main/CODE_OF_CONDUCT.md) (en anglais) pour créer un espace collaboratif inclusif et bienveillant envers tout le monde.
diff --git a/docs/source/fr/installation.md b/docs/source/fr/installation.md
@@ -0,0 +1,161 @@
+<!--⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
+rendered properly in your Markdown viewer.
+-->
+
+# Installation
+
+Avant de commmencer, vous allez avoir besoin de préparer votre environnement
+en installant les packages appropriés.
+
+`huggingface_hub` est testée sur **Python 3.8+**.
+
+## Installation avec pip
+
+Il est fortement recommandé d'installer `huggingface_hub` dans un [environnement virtuel](https://docs.python.org/3/library/venv.html).
+Si vous n'êtes pas familier avec les environnements virtuels Python, suivez ce [guide](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). Un environnement virtuel sera utile lorsque vous devrez gérer des plusieurs projets en parallèle
+afin d'éviter les problèmes de compatibilité entre les différentes dépendances.
+
+Commencez par créer un environnement virtuel à l'emplacement de votre projet:
+
+```bash
+python -m venv .env
+```
+
+Activez l'environnement virtuel sur Linux et macOS:
+
+```bash
+source .env/bin/activate
+```
+
+Activez l'environnement virtuel sur Windows:
+
+```bash
+.env/Scripts/activate
+```
+
+Maintenant, vous êtes prêts à installer `hugginface_hub` [depuis PyPi](https://pypi.org/project/huggingface-hub/):
+
+```bash
+pip install --upgrade huggingface_hub
+```
+
+Une fois l'installation terminée, rendez-vous à la section [vérification](#verification-de-l-installation) pour s'assurer que tout fonctionne correctement.
+
+### Installation des dépendances optionnelles
+
+Certaines dépendances de `huggingface_hub` sont [optionnelles](https://setuptools.pypa.io/en/latest/userguide/dependency_management.html#optional-dependencies) car elles ne sont pas nécessaire pour faire marcher les fonctionnalités principales de `huggingface_hub`.
+Toutefois, certaines fonctionnalités de `huggingface_hub` ne seront pas disponibles si les dépendancces optionnelles ne sont pas installées
+
+Vous pouvez installer des dépendances optionelles via `pip`:
+```bash
+#Installation des dépendances pour les fonctionnalités spécifiques à Tensorflow.
+#/!\ Attention : cette commande n'est pas équivalente à `pip install tensorflow`.
+pip install 'huggingface_hub[tensorflow]'
+
+#Installation des dépendances spécifiques à Pytorch et au CLI.
+pip install 'huggingface_hub[cli,torch]'
+```
+
+Voici une liste des dépendances optionnelles dans `huggingface_hub`:
+- `cli` fournit une interface d'invite de commande plus pratique pour `huggingface_hub`.
+- `fastai`, `torch` et `tensorflow` sont des dépendances pour utiliser des fonctionnalités spécifiques à un framework.
+- `dev` permet de contribuer à la librairie. Cette dépendance inclut `testing` (pour lancer des tests), `typing` (pour lancer le vérifieur de type) et `quality` (pour lancer des linters). 
+
+
+
+### Installation depuis le code source
+
+Dans certains cas, il est intéressant d'installer `huggingface_hub` directement depuis le code source.
+Ceci vous permet d'utiliser la version `main`, contenant les dernières mises à jour, plutôt que
+d'utiliser la dernière version stable. La version `main` est utile pour rester à jour sur les
+derniers développements, par exemple si un bug est corrigé depuis la dernière version officielle
+mais que la nouvelle version n'a pas encore été faite.
+
+Toutefois, cela signifie que la version `main` peut ne pas être stable. Nous travaillons
+afin de rendre la version `main` aussi stable que possible, et la plupart des problèmes sont résolus
+en quelques heures ou jours. Si vous avez un problème, ouvrez une issue afin que
+nous puissions la régler au plus vite !
+
+```bash
+pip install git+https://github.com/huggingface/huggingface_hub
+```
+
+Lorsque vous installez depuis le code source, vous pouvez préciser la branche depuis laquelle installer. Cela permet de tester une nouvelle fonctionnalité ou un bug-fix qui n'a pas encore été merge:
+
+```bash
+pip install git+https://github.com/huggingface/huggingface_hub@ma-branche
+```
+
+Une fois l'installation terminée, rendez-vous à la section [vérification](#verification-de-l-installation) pour s'assurer que tout fonctionne correctement.
+
+### Installation éditable
+
+L'installation depuis le code source vous permet de mettre en place une [installation éditable](https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs). Cette installation sert surtout si vous comptez contribuer à `huggingface_hub`
+et que vous avez besoin de tester rapidement des changements dans le code. Pour cela, vous devez cloner le projet `huggingface_hub` sur votre machine.
+
+```bash
+# Commencez par cloner le dépôt en local
+git clone https://github.com/huggingface/huggingface_hub.git
+
+# Ensuite, installez-le avec le flag -e
+cd huggingface_hub
+pip install -e .
+```
+
+Python regardera maintenant à l'intérieur du dossier dans lequel vous avez cloné le dépôt en
+plus des chemins de librairie classiques. Par exemple, si vos packages Python sont installés dans
+`./.venv/lib/python3.11/site-packages/`, Python regardera aussi dans le dossier que vous avez
+cloné `./huggingface_hub/`.
+
+## Installation avec conda
+
+Si vous avez plutôt l'habitude d'utiliser conda, vous pouvez installer `huggingface_hub` en utilisant le [channel conda-forge](https://anaconda.org/conda-forge/huggingface_hub):
+
+
+```bash
+conda install -c conda-forge huggingface_hub
+```
+
+Une fois l'installation terminée, rendez-vous à la section [vérification](#verification-de-l-installation) pour s'assurer que tout fonctionne correctement.
+
+## Vérification de l'installation
+
+Une fois installée, vérifiez que `huggingface_hub` marche correctement en lançant la commande suivante:
+
+```bash
+python -c "from huggingface_hub import model_info; print(model_info('gpt2'))"
+```
+
+Cette commande va récupérer des informations sur le modèle [gpt2](https://huggingface.co/gpt2) depuis le Hub.
+La sortie devrait ressembler à ça:
+
+```text
+Model Name: gpt2
+Tags: ['pytorch', 'tf', 'jax', 'tflite', 'rust', 'safetensors', 'gpt2', 'text-generation', 'en', 'doi:10.57967/hf/0039', 'transformers', 'exbert', 'license:mit', 'has_space']
+Task: text-generation
+```
+
+## Les limitations Windows
+
+Afin de démocratiser le machine learning au plus grand nombre, nous avons développé `huggingface_hub`
+de manière cross-platform et en particulier, pour qu'elle fonctionne sur une maximum de systèmes d'exploitation différents. Toutefois
+`huggingface_hub` connaît dans certains cas des limitations sur Windows.
+Nous avons listés ci-dessous les problèmes connus. N'hésitez pas à nous signaler si vous rencontrez un problème
+non documenté en ouvrant une [issue sur Github](https://github.com/huggingface/huggingface_hub/issues/new/choose).
+
+- Le cache de `huggingface_hub` a besoin des symlinks pour mettre en cache les fichiers installé depuis le Hub.
+Sur windows, vous devez activer le mode développeur pour lancer ou lancer votre script en tant qu'administrateur
+afin de faire fonctionner les symlinks. S'ils ne sont pas activés, le système de cache fonctionnera toujours mais
+de manière sous-optimale. Consultez les [limitations du cache](./guides/manage-cache#limitations) pour plus de détails.
+- Les noms de fichiers sur le Hub peuvent avoir des caractères spéciaux (par exemple `"path/to?/my/file"`).
+Windows est plus restrictif sur les [caractères spéciaux](https://learn.microsoft.com/en-us/windows/win32/intl/character-sets-used-in-file-names)
+ce qui rend ces fichiers ininstallables sur Windows. Heureusement c'est un cas assez rare.
+Contactez le propriétaire du dépôt si vous pensez que c'est une erreur ou contactez nous
+pour que nous cherchions une solution.
+
+
+## Prochaines étapes
+
+Une fois que `huggingface_hub` est installé correctement sur votre machine, vous aurez peut-être besoin de
+[configurer les variables d'environnement](package_reference/environment_variables) ou de [lire un de nos guides](guides/overview)
+pour vous lancer.