Skip to content

Commit df6366c

Browse files
authored
Fix typos (#2951)
* fix typos * fix typos
1 parent a099273 commit df6366c

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

docs/source/fr/guides/integrations.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ rendered properly in your Markdown viewer.
55
# Intégrez votre framework de ML avec le Hub
66

77
Le Hugging Face Hub facilite l'hébergement et le partage de modèles et de jeux de données.
8-
Des [dizaines de librairies](https://huggingface.co/docs/hub/models-libraries) sont intégrées à cet écosysteme. La communauté travaille constamment à en intégrer de nouvelles et contribue ainsi à faciliter la collaboration dans le milieu du machine learning. La librairie `huggingface_hub` joue un rôle clé dans ce processus puisqu'elle permet d'interagir avec le Hub depuis n'importe quel script Python.
8+
Des [dizaines de librairies](https://huggingface.co/docs/hub/models-libraries) sont intégrées à cet écosystème. La communauté travaille constamment à en intégrer de nouvelles et contribue ainsi à faciliter la collaboration dans le milieu du machine learning. La librairie `huggingface_hub` joue un rôle clé dans ce processus puisqu'elle permet d'interagir avec le Hub depuis n'importe quel script Python.
99

1010
Il existe quatre façons principales d'intégrer une bibliothèque au Hub :
11-
1. **Push to Hub** implémente une méthode pour upload un modèle sur le Hub. Cela inclut les paramètres du modèle, sa fiche descriptive (appelée [Model Card](https://huggingface.co/docs/huggingface_hub/how-to-model-cards)) et toute autre information pertinente lié au modèle (par exemple, les logs d'entrainement). Cette méthode est souvent appelée `push_to_hub()`.
11+
1. **Push to Hub** implémente une méthode pour upload un modèle sur le Hub. Cela inclut les paramètres du modèle, sa fiche descriptive (appelée [Model Card](https://huggingface.co/docs/huggingface_hub/how-to-model-cards)) et toute autre information pertinente liée au modèle (par exemple, les logs d'entraînement). Cette méthode est souvent appelée `push_to_hub()`.
1212
2. **Download from Hub** implémente une méthode pour charger un modèle depuis le Hub. La méthode doit télécharger la configuration et les poids du modèle puis instancier celui-ci. Cette méthode est souvent appelée `from_pretrained` ou `load_from_hub()`.
1313
3. **Inference API** utilise nos serveurs pour faire de l'inférence gratuitement sur des modèles supportés par votre librairie.
1414
4. **Widgets** affiche un widget sur la page d'accueil de votre modèle dans le Hub. Les widgets permettent aux utilisateurs de rapidement tester un modèle depuis le navigateur.
1515

16-
Dans ce guide, nous nous concentreront sur les deux premiers sujets. Nous présenterons les deux approches principales que vous pouvez utiliser pour intégrer une librairie, avec leurs avantages et leurs inconvénients. Tout est résumé à la fin du guide pour vous aider à choisir entre les deux. Veuillez garder à l'esprit que ce ne sont que des conseils, et vous êtes libres de les adapter à votre cas d'usage.
16+
Dans ce guide, nous nous concentrerons sur les deux premiers sujets. Nous présenterons les deux approches principales que vous pouvez utiliser pour intégrer une librairie, avec leurs avantages et leurs inconvénients. Tout est résumé à la fin du guide pour vous aider à choisir entre les deux. Veuillez garder à l'esprit que ce ne sont que des conseils, et vous êtes libres de les adapter à votre cas d'usage.
1717

18-
Si l'Inference API et les Widgets vous intéressent, vous pouvez suivre [ce guide](https://huggingface.co/docs/hub/models-adding-libraries#set-up-the-inference-api). Dans les deux cas, vous pouvez nous contacter si vous intégrez une librairie au Hub et que vous voulez être listée [dans la documentation officielle](https://huggingface.co/docs/hub/models-libraries).
18+
Si l'Inference API et les Widgets vous intéressent, vous pouvez suivre [ce guide](https://huggingface.co/docs/hub/models-adding-libraries#set-up-the-inference-api). Dans les deux cas, vous pouvez nous contacter si vous intégrez une librairie au Hub et que vous voulez être listé [dans la documentation officielle](https://huggingface.co/docs/hub/models-libraries).
1919

2020
## Une approche flexible: les helpers
2121

2222
La première approche pour intégrer une librairie au Hub est d'implémenter les méthodes `push_to_hub` et `from_pretrained`
23-
vous même. Ceci vous donne une flexibilité totale sur le choix du fichier que vous voulez upload/download et sur comment
23+
vous-même. Ceci vous donne une flexibilité totale sur le choix du fichier que vous voulez upload/download et sur comment
2424
gérer les inputs spécifiques à votre framework. Vous pouvez vous référer aux guides : [upload des fichiers](./upload)
2525
et [télécharger des fichiers](./download) pour en savoir plus sur la manière de faire. Par example, c'est de cette manière que l'intégration
2626
de FastAI est implémentée (voir [`push_to_hub_fastai`] et [`from_pretrained_fastai`]).
@@ -81,8 +81,8 @@ upload des poids à la volée, maintenir les poids localement, etc.) consultez l
8181

8282
### Limitations
8383

84-
Bien que très flexible, cette approche a quelques défauts, particulièrement en terme de maintenance. Les utilisateurs
85-
d'Hugging Face sont habitués à utiliser des certaines fonctionnalités lorsqu'ils travaillent avec `huggingface_hub`. Par exemple,
84+
Bien que très flexible, cette approche a quelques défauts, particulièrement en termes de maintenance. Les utilisateurs
85+
d'Hugging Face sont habitués à utiliser certaines fonctionnalités lorsqu'ils travaillent avec `huggingface_hub`. Par exemple,
8686
lors du chargement de fichiers depuis le Hub, il est commun de passer des paramètres tels que:
8787
- `token`: pour télécharger depuis un dépôt privé
8888
- `revision`: pour télécharger depuis une branche spécifique
@@ -92,15 +92,15 @@ lors du chargement de fichiers depuis le Hub, il est commun de passer des param
9292

9393
Lorsque vous pushez des modèles, des paramètres similaires sont utilisables:
9494
- `commit_message`: message de commit personnalisé
95-
- `private`: créé un dépôt privé s'il en manque un
96-
- `create_pr`: créé un pull request au lieu de push vers `main`
95+
- `private`: crée un dépôt privé s'il en manque un
96+
- `create_pr`: crée une pull request au lieu de push vers `main`
9797
- `branch`: push vers une branche au lieu de push sur `main`
9898
- `allow_patterns`/`ignore_patterns`: filtre les fichiers à upload
9999
- `token`
100100
- `api_endpoint`
101101
- ...
102102

103-
Tous ces paramètres peuvent être ajoutés aux implémentations vues ci dessus et passés aux méthodes de `huggingface_hub`.
103+
Tous ces paramètres peuvent être ajoutés aux implémentations vues ci-dessus et passés aux méthodes de `huggingface_hub`.
104104
Toutefois, si un paramètre change ou qu'une nouvelle fonctionnalité est ajoutée, vous devrez mettre à jour votre package.
105105
Supporter ces paramètres implique aussi plus de documentation à maintenir de votre côté. Dans la prochaine section, nous allons voir comment dépasser ces limitations.
106106

@@ -112,21 +112,21 @@ Vous pouvez implémenter ces méthodes vous-même mais cela a des inconvénients
112112
un outil qui utilise l'héritage de classe. Regardons comment ça marche !
113113

114114
Dans beaucoup de cas, une librairie définit déjà les modèles comme des classes Python. La classe contient les
115-
propriétés du modèle et des méthodes pour charger, lancer, entrainer et évaluer le modèle. Notre approche est d'étendre
115+
propriétés du modèle et des méthodes pour charger, lancer, entraîner et évaluer le modèle. Notre approche est d'étendre
116116
cette classe pour inclure les fonctionnalités upload et download en utilisant les mixins. Une [mixin](https://stackoverflow.com/a/547714)
117117
est une classe qui est faite pour étendre une classe existante avec une liste de fonctionnalités spécifiques en utilisant l'héritage de classe.
118118
`huggingface_hub` offre son propre mixin, le [`ModelHubMixin`]. La clef ici est de comprendre son comportement et comment le customiser.
119119

120120
La classe [`ModelHubMixin`] implémente 3 méthodes *public* (`push_to_hub`, `save_pretrained` et `from_pretrained`). Ce
121-
sont les méthodes que vos utilisateurs appeleront pour charger/enregistrer des modèles avec votre librairie.
122-
[`ModelHubMixin`] définit aussi 2 méthodes *private* (`_save_pretrained` et `from_pretrained`). Ce sont celle que vous
121+
sont les méthodes que vos utilisateurs appelleront pour charger/enregistrer des modèles avec votre librairie.
122+
[`ModelHubMixin`] définit aussi 2 méthodes *private* (`_save_pretrained` et `from_pretrained`). Ce sont celles que vous
123123
devez implémenter. Ainsi, pour intégrer votre librairie, vous devez :
124124

125125
1. Faire en sorte que votre classe Model hérite de [`ModelHubMixin`].
126126
2. Implémenter les méthodes privées:
127127
- [`~ModelHubMixin._save_pretrained`]: méthode qui prend en entrée un chemin vers un directory et qui sauvegarde le modèle.
128128
Vous devez écrire toute la logique pour dump votre modèle de cette manière: model card, poids du modèle, fichiers de configuration,
129-
et logs d'entrainement. Toute information pertinente pour ce modèle doit être gérée par cette méthode. Les
129+
et logs d'entraînement. Toute information pertinente pour ce modèle doit être gérée par cette méthode. Les
130130
[model cards](https://huggingface.co/docs/hub/model-cards) sont particulièrement importantes pour décrire votre modèle. Vérifiez
131131
[notre guide d'implémentation](./model-cards) pour plus de détails.
132132
- [`~ModelHubMixin._from_pretrained`]: **méthode de classe** prenant en entrée un `model_id` et qui retourne un modèle instancié.
@@ -262,7 +262,7 @@ Et c'est fini ! Votre librairie permet maintenant aux utilisateurs d'upload et d
262262
## Comparaison
263263

264264
Résumons rapidement les deux approches que nous avons vu avec leurs avantages et leurs défauts. Le tableau ci-dessous
265-
est purement indicatif. Votre framework aura peut-êre des spécifités à prendre en compte. Ce guide
265+
est purement indicatif. Votre framework aura peut-êre des spécificités à prendre en compte. Ce guide
266266
est ici pour vous donner des indications et des idées sur comment gérer l'intégration. Dans tous les cas,
267267
n'hésitez pas à nous contacter si vous avez une question !
268268

@@ -272,4 +272,4 @@ n'hésitez pas à nous contacter si vous avez une question !
272272
| Expérience utilisateur | `model = load_from_hub(...)`<br>`push_to_hub(model, ...)` | `model = MyModel.from_pretrained(...)`<br>`model.push_to_hub(...)` |
273273
| Flexible | Très flexible.<br>Vous controllez complètement l'implémentation. | Moins flexible.<br>Votre framework doit avoir une classe de modèle. |
274274
| Maintenance | Plus de maintenance pour ajouter du support pour la configuration, et de nouvelles fonctionnalités. Peut aussi nécessiter de fixx des problèmes signalés par les utilisateurs.| Moins de maintenance vu que la plupart des intégrations avec le Hub sont implémentés dans `huggingface_hub` |
275-
| Documentation / Anotation de type| A écrire à la main | Géré partiellement par `huggingface_hub`. |
275+
| Documentation / Anotation de type| A écrire à la main | Géré partiellement par `huggingface_hub`. |

docs/source/fr/installation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ rendered properly in your Markdown viewer.
44

55
# Installation
66

7-
Avant de commmencer, vous allez avoir besoin de préparer votre environnement
7+
Avant de commencer, vous allez avoir besoin de préparer votre environnement
88
en installant les packages appropriés.
99

1010
`huggingface_hub` est testée sur **Python 3.8+**.
@@ -44,9 +44,9 @@ Une fois l'installation terminée, rendez-vous à la section [vérification](#ve
4444
### Installation des dépendances optionnelles
4545

4646
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`.
47-
Toutefois, certaines fonctionnalités de `huggingface_hub` ne seront pas disponibles si les dépendancces optionnelles ne sont pas installées
47+
Toutefois, certaines fonctionnalités de `huggingface_hub` ne seront pas disponibles si les dépendances optionnelles ne sont pas installées
4848

49-
Vous pouvez installer des dépendances optionelles via `pip`:
49+
Vous pouvez installer des dépendances optionnelles via `pip`:
5050
```bash
5151
#Installation des dépendances pour les fonctionnalités spécifiques à Tensorflow.
5252
#/!\ Attention : cette commande n'est pas équivalente à `pip install tensorflow`.
@@ -140,10 +140,10 @@ Task: text-generation
140140
Afin de démocratiser le machine learning au plus grand nombre, nous avons développé `huggingface_hub`
141141
de manière cross-platform et en particulier, pour qu'elle fonctionne sur une maximum de systèmes d'exploitation différents. Toutefois
142142
`huggingface_hub` connaît dans certains cas des limitations sur Windows.
143-
Nous avons listés ci-dessous les problèmes connus. N'hésitez pas à nous signaler si vous rencontrez un problème
143+
Nous avons listé ci-dessous les problèmes connus. N'hésitez pas à nous signaler si vous rencontrez un problème
144144
non documenté en ouvrant une [issue sur Github](https://github.com/huggingface/huggingface_hub/issues/new/choose).
145145

146-
- Le cache de `huggingface_hub` a besoin des symlinks pour mettre en cache les fichiers installé depuis le Hub.
146+
- Le cache de `huggingface_hub` a besoin des symlinks pour mettre en cache les fichiers installés depuis le Hub.
147147
Sur windows, vous devez activer le mode développeur pour lancer ou lancer votre script en tant qu'administrateur
148148
afin de faire fonctionner les symlinks. S'ils ne sont pas activés, le système de cache fonctionnera toujours mais
149149
de manière sous-optimale. Consultez les [limitations du cache](./guides/manage-cache#limitations) pour plus de détails.

utils/check_all_variable.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def parse_all_definition(content: str) -> List[str]:
4343
"""
4444
Extract the current __all__ contents from file content.
4545
46-
This is prefered over "from huggingface_hub import __all__ as current_items" to handle
46+
This is preferred over "from huggingface_hub import __all__ as current_items" to handle
4747
case where __all__ is not defined or malformed in the file we want to be able to fix
4848
such issues rather than crash also, we are interested in the file content.
4949
"""

0 commit comments

Comments
 (0)