-
Notifications
You must be signed in to change notification settings - Fork 570
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
🌐 [i18n-KO] Translated README, landing docs to Korean #1667
Merged
+868
−3
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
edcb0af
docs: ko: initialize Korean docs
wonhyeongseo b227486
docs: ko: README_ko.md
wonhyeongseo 260f0ff
docs: ko: index.md
wonhyeongseo 2eb26aa
docs: ko: installation.md
wonhyeongseo 984138f
docs: ko: quick-start.md
wonhyeongseo 4d279f4
fix: add entries to _toctree.yml
wonhyeongseo cf08c72
fix: delete _redirects.yml from new language docs
wonhyeongseo 57c9a48
docs: ko: guides/overview.md
wonhyeongseo a0442c0
docs: ko: guides/download.md
wonhyeongseo d5661df
fix: add Deutsch to README_ko.md
wonhyeongseo c0f8ec4
fix: point to English guides for now
wonhyeongseo d53260f
fix: add entries to _toctree.yml
wonhyeongseo fd6868b
fix: recover overview.md
wonhyeongseo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,155 @@ | ||
<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>공식 Huggingface Hub 파이썬 클라이언트</i> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://huggingface.co/docs/huggingface_hub/ko/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> | ||
<a href="https://github.com/huggingface/huggingface_hub/blob/main/README.md">English</a> | | ||
<a href="https://github.com/huggingface/huggingface_hub/blob/main/README_de.md">Deutsch</a> | | ||
<b>한국어</b> | ||
<p> | ||
</h4> | ||
|
||
--- | ||
|
||
**기술 문서**: <a href="https://hf.co/docs/huggingface_hub" target="_blank">https://hf.co/docs/huggingface_hub</a> | ||
|
||
**소스 코드**: <a href="https://github.com/huggingface/huggingface_hub" target="_blank">https://github.com/huggingface/huggingface_hub</a> | ||
|
||
--- | ||
|
||
## huggingface_hub 라이브러리 개요 | ||
|
||
`huggingface_hub` 라이브러리는 [Hugging Face Hub](https://huggingface.co/)와 상호작용할 수 있게 해줍니다. Hugging Face Hub는 창작자와 협업자를 위한 오픈소스 머신러닝 플랫폼입니다. 여러분의 프로젝트에 적합한 사전 훈련된 모델과 데이터셋을 발견하거나, Hub에 호스팅된 수천 개의 머신러닝 앱들을 사용해보세요. 또한, 여러분이 만든 모델, 데이터셋, 데모를 커뮤니티와 공유할 수도 있습니다. `huggingface_hub` 라이브러리는 파이썬으로 이 모든 것을 간단하게 할 수 있는 방법을 제공합니다. | ||
|
||
## 주요 기능 | ||
|
||
- Hub에서 [파일을 다운로드](https://huggingface.co/docs/huggingface_hub/main/ko/guides/download) | ||
- Hub에 [파일을 업로드](https://huggingface.co/docs/huggingface_hub/main/en/guides/upload) (영어) | ||
- [레포지토리를 관리](https://huggingface.co/docs/huggingface_hub/main/en/guides/repository) (영어) | ||
- 배포된 모델에 [추론을 실행](https://huggingface.co/docs/huggingface_hub/main/en/guides/inference) (영어) | ||
- 모델, 데이터셋, Space를 [검색](https://huggingface.co/docs/huggingface_hub/main/en/guides/search) (영어) | ||
- [모델 카드를 공유](https://huggingface.co/docs/huggingface_hub/main/en/guides/model-cards)하여 모델을 문서화 (영어) | ||
- PR과 댓글을 통해 [커뮤니티와 소통](https://huggingface.co/docs/huggingface_hub/main/en/guides/community) (영어) | ||
|
||
## 설치 | ||
|
||
[pip](https://pypi.org/project/huggingface-hub/)로 `huggingface_hub` 패키지를 설치하세요: | ||
|
||
```bash | ||
pip install huggingface_hub | ||
``` | ||
|
||
원한다면 [conda](https://huggingface.co/docs/huggingface_hub/ko/installation#install-with-conda)를 이용하여 설치할 수도 있습니다. | ||
|
||
기본 패키지를 작게 유지하기 위해 `huggingface_hub`는 유용한 의존성을 추가적으로 제공합니다. 추론과 관련된 기능을 원한다면, 아래를 실행하세요: | ||
|
||
```bash | ||
pip install huggingface_hub[inference] | ||
``` | ||
|
||
설치와 선택적 의존성에 대해 더 알아보려면, [설치 가이드](https://huggingface.co/docs/huggingface_hub/ko/installation)를 참고하세요. | ||
|
||
## 맛보기 | ||
|
||
### 파일 다운로드 | ||
|
||
파일 하나의 경우: | ||
|
||
```py | ||
from huggingface_hub import hf_hub_download | ||
|
||
hf_hub_download(repo_id="tiiuae/falcon-7b-instruct", filename="config.json") | ||
``` | ||
|
||
레포지토리 전체의 경우: | ||
|
||
```py | ||
from huggingface_hub import snapshot_download | ||
|
||
snapshot_download("stabilityai/stable-diffusion-2-1") | ||
``` | ||
|
||
파일은 로컬 캐시 폴더에 다운로드됩니다. 자세한 내용은 [이 가이드](https://huggingface.co/docs/huggingface_hub/ko/guides/manage-cache)를 참조하세요. | ||
|
||
### 로그인 | ||
|
||
Hugging Face Hub는 토큰을 사용하여 애플리케이션을 인증합니다([문서](https://huggingface.co/docs/hub/security-tokens) 참조). 컴퓨터에서 로그인하려면 CLI를 사용하세요: | ||
|
||
```bash | ||
huggingface-cli login | ||
# 또는 환경 변수로 지정해주세요 | ||
huggingface-cli login --token $HUGGINGFACE_TOKEN | ||
``` | ||
|
||
### 레포지토리 생성 | ||
|
||
```py | ||
from huggingface_hub import create_repo | ||
|
||
create_repo(repo_id="super-cool-model") | ||
``` | ||
|
||
### 파일 업로드 | ||
|
||
파일 하나의 경우: | ||
|
||
```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", | ||
) | ||
``` | ||
|
||
레포지토리 전체의 경우: | ||
|
||
```py | ||
from huggingface_hub import upload_folder | ||
|
||
upload_folder( | ||
folder_path="/path/to/local/space", | ||
repo_id="username/my-cool-space", | ||
repo_type="space", | ||
) | ||
``` | ||
|
||
자세한 내용은 [업로드 가이드](https://huggingface.co/docs/huggingface_hub/ko/guides/upload)를 참조하세요. | ||
|
||
## Hugging Face Hub와 함께 성장하기 | ||
|
||
저희는 멋진 오픈소스 ML 라이브러리들과 협력하여, 모델 호스팅과 버전 관리를 무료로 제공하고 있습니다. 이미 통합된 라이브러리들은 [여기](https://huggingface.co/docs/hub/libraries)서 확인할 수 있습니다. | ||
|
||
이렇게 하면 다음과 같은 장점이 있습니다: | ||
|
||
- 라이브러리 사용자들의 모델이나 데이터셋을 무료로 호스팅해줍니다. | ||
- git을 기반으로 한 방식으로, 아주 큰 파일들도 버전을 관리할 수 있습니다. | ||
- 공개된 모든 모델에 대해 추론 API를 호스팅해줍니다. | ||
- 업로드된 모델들을 브라우저에서 쉽게 사용할 수 있는 위젯을 제공합니다. | ||
- 누구나 여러분의 라이브러리에 새로운 모델을 업로드할 수 있습니다. 모델이 검색될 수 있도록 해당 태그만 추가하면 됩니다. | ||
- 다운로드 속도가 매우 빠릅니다! 왜냐하면 Cloudfront (CDN)를 이용하여 전 세계 어디에서나 빠르게 다운로드할 수 있도록 지역적으로 복제해뒀기 때문입니다. | ||
- 사용 통계와 더 많은 기능들을 제공합니다. | ||
|
||
여러분의 라이브러리를 통합하고 싶다면, 이슈를 열어서 의견을 나눠주세요. 통합 과정을 안내하기 위해 ❤️을 담아 [단계별 가이드](https://huggingface.co/docs/hub/adding-a-library)를 작성했습니다. | ||
|
||
## (기능 요청, 버그 패치 등의) 기여는 대환영입니다 💙💚💛💜🧡❤️ | ||
|
||
모든 분들의 기여를 환영하며, 소중히 생각합니다. 코드 작성만이 커뮤니티에 도움을 주는 유일한 방법이 아니에요. | ||
질문에 답하거나, 다른 분들을 돕거나, 컨택하거나, 문서를 개선하는 것도 커뮤니티에 큰 도움이 됩니다. | ||
지금 시작하려면 간단한 [기여 가이드](https://github.com/huggingface/huggingface_hub/blob/main/CONTRIBUTING.md)를 참조해주세요. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
- title: "시작하기" | ||
sections: | ||
- local: index | ||
title: 홈 | ||
- local: quick-start | ||
title: 둘러보기 | ||
- local: installation | ||
title: 설치 방법 | ||
- title: "(번역 중) How-to 가이드" | ||
sections: | ||
- local: guides/overview | ||
title: 개요 | ||
- local: guides/download | ||
title: 파일 다운로드하기 | ||
- local: in_translation | ||
title: (번역 중) Upload files | ||
- local: in_translation | ||
title: (번역 중) HfFileSystem | ||
- local: in_translation | ||
title: (번역 중) Repository | ||
- local: in_translation | ||
title: (번역 중) Search | ||
- local: in_translation | ||
title: (번역 중) Inference | ||
- local: in_translation | ||
title: (번역 중) Community Tab | ||
- local: in_translation | ||
title: (번역 중) Cache | ||
- local: in_translation | ||
title: (번역 중) Model Cards | ||
- local: in_translation | ||
title: (번역 중) Manage your Space | ||
- local: in_translation | ||
title: (번역 중) Integrate a library | ||
- local: in_translation | ||
title: (번역 중) Webhooks server | ||
- title: "(번역 중) 개념 가이드" | ||
sections: | ||
- local: in_translation | ||
title: (번역 중) Git vs HTTP paradigm | ||
- title: "(번역 중) 라이브러리 레퍼런스" | ||
sections: | ||
- local: in_translation | ||
title: (번역 중) Overview | ||
- local: in_translation | ||
title: (번역 중) Login and logout | ||
- local: in_translation | ||
title: (번역 중) Environment variables | ||
- local: in_translation | ||
title: (번역 중) Managing local and online repositories | ||
- local: in_translation | ||
title: (번역 중) Hugging Face Hub API | ||
- local: in_translation | ||
title: (번역 중) Downloading files | ||
- local: in_translation | ||
title: (번역 중) Mixins & serialization methods | ||
- local: in_translation | ||
title: (번역 중) Inference Client | ||
- local: in_translation | ||
title: (번역 중) HfFileSystem | ||
- local: in_translation | ||
title: (번역 중) Utilities | ||
- local: in_translation | ||
title: (번역 중) Discussions and Pull Requests | ||
- local: in_translation | ||
title: (번역 중) Cache-system reference | ||
- local: in_translation | ||
title: (번역 중) Repo Cards and Repo Card Data | ||
- local: in_translation | ||
title: (번역 중) Space runtime | ||
- local: in_translation | ||
title: (번역 중) TensorBoard logger | ||
- local: in_translation | ||
title: (번역 중) Webhooks server |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
guides/overview
has not being added to this PR. Would be best to either remove it (set toin_translation
) or add a translated version of the overview pageThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Wauplin, thank you for your helpful feedback!
There was a mistake in deleting
overview.md
instead ofupload.md
. It has been fixed in a new commit.The document will be proof-read for the next 3 days. Please feel free to share any suggestions or comments. Otherwise, I think we can merge it after that.