Skip to content

Commit

Permalink
🌐 [i18n-DE] Translate docs to German (#1646)
Browse files Browse the repository at this point in the history
* Translate main base docs

* Correct some typos and update TOC status

* Add inference to German doc translation

* Add webhooks_server to German doc translation

* Add German README

* Add download guide to German translations

* Add webhooks_server and remove wrong file

* Add overview and community guide

* Add upload guide and update TOC

* Add HfFileSystem

* Add search guide

* Add Model Cards

* Add Repository

* Add integrations guide

* Add Manage your Space guide

* Add Cache guide

* Address PR review comments

* Add language to build documentation workflows

---------

Co-authored-by: Lucain <lucainp@gmail.com>
  • Loading branch information
martinbrose and Wauplin committed Sep 19, 2023
1 parent f408fdd commit 609bbe4
Show file tree
Hide file tree
Showing 21 changed files with 3,914 additions and 14 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
with:
commit_sha: ${{ github.sha }}
package: huggingface_hub
languages: en
languages: de en
secrets:
token: ${{ secrets.HUGGINGFACE_PUSH }}
hf_token: ${{ secrets.HF_DOC_BUILD_PUSH }}
2 changes: 1 addition & 1 deletion .github/workflows/build_pr_documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ jobs:
commit_sha: ${{ github.event.pull_request.head.sha }}
pr_number: ${{ github.event.number }}
package: huggingface_hub
languages: en
languages: de en
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,19 @@
</p>

<p align="center">
<a href="https://huggingface.co/docs/huggingface_hub/index"><img alt="Documentation" src="https://img.shields.io/website/http/huggingface.co/docs/huggingface_hub/index.svg?down_color=red&down_message=offline&up_message=online&label=doc"></a>
<a href="https://huggingface.co/docs/huggingface_hub/en/index"><img alt="Documentation" src="https://img.shields.io/website/http/huggingface.co/docs/huggingface_hub/index.svg?down_color=red&down_message=offline&up_message=online&label=doc"></a>
<a href="https://github.com/huggingface/huggingface_hub/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/huggingface/huggingface_hub.svg"></a>
<a href="https://github.com/huggingface/huggingface_hub"><img alt="PyPi version" src="https://img.shields.io/pypi/pyversions/huggingface_hub.svg"></a>
<a href="https://pypi.org/project/huggingface-hub"><img alt="downloads" src="https://static.pepy.tech/badge/huggingface_hub/month"></a>
<a href="https://codecov.io/gh/huggingface/huggingface_hub"><img alt="Code coverage" src="https://codecov.io/gh/huggingface/huggingface_hub/branch/main/graph/badge.svg?token=RXP95LE2XL"></a>
</p>

<h4 align="center">
<p>
<b>English</b> |
<a href="https://github.com/huggingface/huggingface_hub/blob/main/README_de.md">Deutsch</a>
<p>
</h4>
---

**Documentation**: <a href="https://hf.co/docs/huggingface_hub" target="_blank">https://hf.co/docs/huggingface_hub</a>
Expand All @@ -30,13 +36,13 @@ The `huggingface_hub` library allows you to interact with the [Hugging Face Hub]

## Key features

- [Download files](https://huggingface.co/docs/huggingface_hub/guides/download) from the Hub.
- [Upload files](https://huggingface.co/docs/huggingface_hub/guides/upload) to the Hub.
- [Manage your repositories](https://huggingface.co/docs/huggingface_hub/guides/repository).
- [Run Inference](https://huggingface.co/docs/huggingface_hub/guides/inference) on deployed models.
- [Search](https://huggingface.co/docs/huggingface_hub/guides/search) for models, datasets and Spaces.
- [Share Model Cards](https://huggingface.co/docs/huggingface_hub/main/en/guides/model-cards) to document your models.
- [Engage with the community](https://huggingface.co/docs/huggingface_hub/guides/community) through PRs and comments.
- [Download files](https://huggingface.co/docs/huggingface_hub/en/guides/download) from the Hub.
- [Upload files](https://huggingface.co/docs/huggingface_hub/en/guides/upload) to the Hub.
- [Manage your repositories](https://huggingface.co/docs/huggingface_hub/en/guides/repository).
- [Run Inference](https://huggingface.co/docs/huggingface_hub/en/guides/inference) on deployed models.
- [Search](https://huggingface.co/docs/huggingface_hub/en/guides/search) for models, datasets and Spaces.
- [Share Model Cards](https://huggingface.co/docs/huggingface_hub/en/guides/model-cards) to document your models.
- [Engage with the community](https://huggingface.co/docs/huggingface_hub/en/guides/community) through PRs and comments.

## Installation

Expand All @@ -46,15 +52,15 @@ Install the `huggingface_hub` package with [pip](https://pypi.org/project/huggin
pip install huggingface_hub
```

If you prefer, you can also install it with [conda](https://huggingface.co/docs/huggingface_hub/installation#install-with-conda).
If you prefer, you can also install it with [conda](https://huggingface.co/docs/huggingface_hub/en/installation#install-with-conda).

In order to keep the package minimal by default, `huggingface_hub` comes with optional dependencies useful for some use cases. For example, if you want have a complete experience for Inference, run:

```bash
pip install huggingface_hub[inference]
```

To learn more installation and optional dependencies, check out the [installation guide](https://huggingface.co/docs/huggingface_hub/installation).
To learn more installation and optional dependencies, check out the [installation guide](https://huggingface.co/docs/huggingface_hub/en/installation).

## Quick start

Expand All @@ -76,7 +82,7 @@ from huggingface_hub import snapshot_download
snapshot_download("stabilityai/stable-diffusion-2-1")
```

Files will be downloaded in a local cache folder. More details in [this guide](https://huggingface.co/docs/huggingface_hub/guides/manage-cache).
Files will be downloaded in a local cache folder. More details in [this guide](https://huggingface.co/docs/huggingface_hub/en/guides/manage-cache).

### Login

Expand Down Expand Up @@ -122,7 +128,7 @@ upload_folder(
)
```

For details in the [upload guide](https://huggingface.co/docs/huggingface_hub/guides/upload).
For details in the [upload guide](https://huggingface.co/docs/huggingface_hub/en/guides/upload).

## Integrating to the Hub.

Expand Down
151 changes: 151 additions & 0 deletions README_de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
<p align="center">
<br/>
<img alt="huggingface_hub library logo" src="https://huggingface.co/datasets/huggingface/documentation-images/raw/main/huggingface_hub.svg" width="376" height="59" style="max-width: 100%;">
<br/>
</p>

<p align="center">
<i>Der offizielle Python-Client für den Huggingface Hub.</i>
</p>

<p align="center">
<a href="https://huggingface.co/docs/huggingface_hub/de/index"><img alt="Dokumentation" src="https://img.shields.io/website/http/huggingface.co/docs/huggingface_hub/index.svg?down_color=red&down_message=offline&up_message=online&label=doc"></a>
<a href="https://github.com/huggingface/huggingface_hub/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/huggingface/huggingface_hub.svg"></a>
<a href="https://github.com/huggingface/huggingface_hub"><img alt="PyPi version" src="https://img.shields.io/pypi/pyversions/huggingface_hub.svg"></a>
<a href="https://pypi.org/project/huggingface-hub"><img alt="downloads" src="https://static.pepy.tech/badge/huggingface_hub/month"></a>
<a href="https://codecov.io/gh/huggingface/huggingface_hub"><img alt="Code coverage" src="https://codecov.io/gh/huggingface/huggingface_hub/branch/main/graph/badge.svg?token=RXP95LE2XL"></a>
</p>

<h4 align="center">
<p>
<a href="https://github.com/huggingface/huggingface_hub/blob/main/README.md">English</a> |
<b>Deutsch</b>
<p>
</h4>
---

**Dokumentation**: <a href="https://hf.co/docs/huggingface_hub" target="_blank">https://hf.co/docs/huggingface_hub</a>

**Quellcode**: <a href="https://github.com/huggingface/huggingface_hub" target="_blank">https://github.com/huggingface/huggingface_hub</a>

---

## Willkommen bei der huggingface_hub Bibliothek

Die `huggingface_hub` Bibliothek ermöglicht Ihnen die Interaktion mit dem [Hugging Face Hub](https://huggingface.co/), einer Plattform, die Open-Source Machine Learning für Entwickler und Mitwirkende demokratisiert. Entdecken Sie vortrainierte Modelle und Datensätze für Ihre Projekte oder spielen Sie mit den Tausenden von Machine-Learning-Apps, die auf dem Hub gehostet werden. Sie können auch Ihre eigenen Modelle, Datensätze und Demos mit der Community teilen. Die `huggingface_hub` Bibliothek bietet eine einfache Möglichkeit, all dies mit Python zu tun.

## Hauptmerkmale

- Dateien vom Hub [herunterladen](https://huggingface.co/docs/huggingface_hub/de/guides/download).
- Dateien auf den Hub [hochladen](https://huggingface.co/docs/huggingface_hub/de/guides/upload).
- [Verwalten Ihrer Repositories](https://huggingface.co/docs/huggingface_hub/de/guides/repository).
- [Ausführen von Inferenz](https://huggingface.co/docs/huggingface_hub/de/guides/inference) auf bereitgestellten Modellen.
- [Suche](https://huggingface.co/docs/huggingface_hub/de/guides/search) nach Modellen, Datensätzen und Spaces.
- [Model Cards teilen](https://huggingface.co/docs/huggingface_hub/de/guides/model-cards), um Ihre Modelle zu dokumentieren.
- [Mit der Community interagieren](https://huggingface.co/docs/huggingface_hub/de/guides/community), durch PRs und Kommentare.

## Installation

Installieren Sie das `huggingface_hub` Paket mit [pip](https://pypi.org/project/huggingface-hub/):

```bash
pip install huggingface_hub
```

Wenn Sie möchten, können Sie es auch mit [conda](https://huggingface.co/docs/huggingface_hub/de/installation#installieren-mit-conda) installieren.

Um das Paket standardmäßig minimal zu halten, kommt `huggingface_hub` mit optionalen Abhängigkeiten, die für einige Anwendungsfälle nützlich sind. Zum Beispiel, wenn Sie ein vollständiges Erlebnis für Inferenz möchten, führen Sie den folgenden Befehl aus:

```bash
pip install huggingface_hub[inference]
```

Um mehr über die Installation und optionale Abhängigkeiten zu erfahren, sehen Sie sich bitte den [Installationsleitfaden](https://huggingface.co/docs/huggingface_hub/de/installation) an.

## Schnellstart

### Dateien herunterladen

Eine einzelne Datei herunterladen

```py
from huggingface_hub import hf_hub_download

hf_hub_download(repo_id="tiiuae/falcon-7b-instruct", filename="config.json")
```

Oder eine gesamte Repository

```py
from huggingface_hub import snapshot_download

snapshot_download("stabilityai/stable-diffusion-2-1")
```

Dateien werden in einen lokalen Cache-Ordner heruntergeladen. Weitere Details finden Sie in diesem [Leitfaden](https://huggingface.co/docs/huggingface_hub/de/guides/manage-cache).

### Anmeldung

Der Hugging Face Hub verwendet Tokens zur Authentifizierung von Anwendungen (siehe [Dokumentation](https://huggingface.co/docs/hub/security-tokens)). Um sich an Ihrem Computer anzumelden, führen Sie das folgende Kommando in der Befehlszeile aus:

```bash
huggingface-cli login
# oder mit einer Umgebungsvariablen
huggingface-cli login --token $HUGGINGFACE_TOKEN
```

### Eine Repository erstellen

```py
from huggingface_hub import create_repo

create_repo(repo_id="super-cool-model")
```

### Dateien hochladen

Eine einzelne Datei hochladen

```py
from huggingface_hub import upload_file

upload_file(
path_or_fileobj="/home/lysandre/dummy-test/README.md",
path_in_repo="README.md",
repo_id="lysandre/test-model",
)
```

Oder einen gesamten Ordner

```py
from huggingface_hub import upload_folder

upload_folder(
folder_path="/path/to/local/space",
repo_id="username/my-cool-space",
repo_type="space",
)
```

Weitere Informationen finden Sie im [Upload-Leitfaden](https://huggingface.co/docs/huggingface_hub/de/guides/upload).

## Integration in den Hub

Wir arbeiten mit coolen Open-Source-ML-Bibliotheken zusammen, um kostenloses Model-Hosting und -Versionierung anzubieten. Die bestehenden Integrationen finden Sie [hier](https://huggingface.co/docs/hub/libraries).

Die Vorteile sind:

- Kostenloses Hosting von Modellen oder Datensätzen für Bibliotheken und deren Benutzer..
- Eingebaute Dateiversionierung, selbst bei sehr großen Dateien, dank eines git-basierten Ansatzes.
- Bereitgestellte Inferenz-API für alle öffentlich verfügbaren Modelle.
- In-Browser-Widgets zum Spielen mit den hochgeladenen Modellen.
- Jeder kann ein neues Modell für Ihre Bibliothek hochladen, es muss nur das entsprechende Tag hinzugefügt werden, damit das Modell auffindbar ist.
- Schnelle Downloads! Wir verwenden Cloudfront (ein CDN), um Downloads zu geo-replizieren, sodass sie von überall auf der Welt blitzschnell sind.
- Nutzungsstatistiken und mehr Funktionen in Kürze.

Wenn Sie Ihre Bibliothek integrieren möchten, öffnen Sie gerne ein Issue, um die Diskussion zu beginnen. Wir haben mit ❤️ einen [schrittweisen Leitfaden](https://huggingface.co/docs/hub/adding-a-library) geschrieben, der zeigt, wie diese Integration durchgeführt wird.

## Beiträge (Feature-Anfragen, Fehler usw.) sind super willkommen 💙💚💛💜🧡❤️

Jeder ist willkommen beizutragen, und wir schätzen den Beitrag jedes Einzelnen. Code zu schreiben ist nicht der einzige Weg, der Community zu helfen. Fragen zu beantworten, anderen zu helfen, sich zu vernetzen und die Dokumentationen zu verbessern, sind für die Gemeinschaft von unschätzbarem Wert. Wir haben einen [Beitrags-Leitfaden](https://github.com/huggingface/huggingface_hub/blob/main/CONTRIBUTING.md) geschrieben, der zusammenfasst, wie Sie beginnen können, zu dieser Repository beizutragen.
36 changes: 36 additions & 0 deletions docs/source/de/_toctree.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- title: "Starten"
sections:
- local: index
title: Home
- local: quick-start
title: Kurzanleitung
- local: installation
title: Installation
- title: "Anleitungen"
sections:
- local: guides/overview
title: Übersicht
- local: guides/download
title: Dateien herunterladen
- local: guides/upload
title: Dateien hochladen
- local: guides/hf_file_system
title: HfFileSystem
- local: guides/repository
title: Repository
- local: guides/search
title: Suche
- local: guides/inference
title: Inferenz
- local: guides/community
title: Community-Tab
- local: guides/manage-cache
title: Cache
- local: guides/model-cards
title: Model Cards
- local: guides/manage-spaces
title: Verwalten Ihres Spaces
- local: guides/integrations
title: Integrieren einer Bibliothek
- local: guides/webhooks_server
title: Webhooks server

0 comments on commit 609bbe4

Please sign in to comment.