From e15cae348b15c836b5d0df02b9e5eb83ea86a3e8 Mon Sep 17 00:00:00 2001 From: Sungmin Oh Date: Tue, 18 Jun 2024 05:54:03 +0900 Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=90=20[i18n-KO]=20Translated=20`packag?= =?UTF-8?q?e=5Freference/webhooks=5Fserver.md`=20to=20Korean=20(#2344)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: ko: package_reference/webhooks_server * feat: nmt draft * fix: manual edits --- docs/source/ko/_toctree.yml | 4 +- .../ko/package_reference/webhooks_server.md | 75 +++++++++++++++++++ 2 files changed, 77 insertions(+), 2 deletions(-) create mode 100644 docs/source/ko/package_reference/webhooks_server.md diff --git a/docs/source/ko/_toctree.yml b/docs/source/ko/_toctree.yml index 9144ae7641..e4a9a6aee5 100644 --- a/docs/source/ko/_toctree.yml +++ b/docs/source/ko/_toctree.yml @@ -82,7 +82,7 @@ title: Space 런타임 - local: package_reference/tensorboard title: TensorBoard 로거 - - local: in_translation - title: (번역 중) Webhooks server + - local: package_reference/webhooks_server + title: 웹훅 서버 - local: package_reference/serialization title: 직렬화 \ No newline at end of file diff --git a/docs/source/ko/package_reference/webhooks_server.md b/docs/source/ko/package_reference/webhooks_server.md new file mode 100644 index 0000000000..9712c6c0be --- /dev/null +++ b/docs/source/ko/package_reference/webhooks_server.md @@ -0,0 +1,75 @@ + + +# 웹훅 서버[[webhooks-server]] + +웹훅은 MLOps 관련 기능의 기반이 됩니다. 이를 통해 특정 저장소의 새로운 변경 사항을 수신하거나, 관심 있는 특정 사용자/조직에 속한 모든 저장소의 변경 사항을 받아볼 수 있습니다. +Huggingface Hub의 웹훅에 대해 더 자세히 알아보려면 이 [가이드](https://huggingface.co/docs/hub/webhooks)를 읽어보세요. + + + +웹훅 서버를 설정하고 Space로 배포하는 방법은 이 단계별 [가이드](../guides/webhooks_server)를 확인하세요. + + + + + +이 기능은 실험적인 기능입니다. 본 API는 현재 개선 작업 중이며, 향후 사전 통지 없이 주요 변경 사항이 도입될 수 있음을 의미합니다. `requirements`에서 `huggingface_hub`의 버전을 고정하는 것을 권장합니다. 참고로 실험적 기능을 사용하면 경고가 트리거 됩니다. 이 경고 트리거를 비활성화 시키길 원한다면 환경변수 `HF_HUB_DISABLE_EXPERIMENTAL_WARNING=1`를 설정하세요. + + + +## 서버[[server]] +여기서 서버는 하나의 [Gradio](https://gradio.app/) 앱을 의미합니다. Gradio에는 사용자 또는 사용자에게 지침을 표시하는 UI와 웹훅을 수신하기 위한 API가 있습니다. 웹훅 엔드포인트를 구현하는 것은 함수에 데코레이터를 추가하는 것만큼 간단합니다. 서버를 Space에 배포하기 전에 Gradio 터널을 사용하여 웹훅을 머신으로 리디렉션하여 디버깅할 수 있습니다. + +### WebhooksServer[[huggingface_hub.WebhooksServer]] + +[[autodoc]] huggingface_hub.WebhooksServer + +### @webhook_endpoint[[huggingface_hub.webhook_endpoint]] + +[[autodoc]] huggingface_hub.webhook_endpoint + +## 페이로드[[huggingface_hub.WebhookPayload]] + +[`WebhookPayload`]는 웹훅의 페이로드를 포함하는 기본 데이터 구조입니다. 이것은 `pydantic` 클래스로서 FastAPI에서 매우 쉽게 사용할 수 있습니다. 즉 WebhookPayload를 웹후크 엔드포인트에 매개변수로 전달하면 자동으로 유효성이 검사되고 파이썬 객체로 파싱됩니다. + +웹훅 페이로드에 대한 자세한 사항은 이 [가이드](https://huggingface.co/docs/hub/webhooks#webhook-payloads)를 참고하세요. + +[[autodoc]] huggingface_hub.WebhookPayload + +### WebhookPayload[[huggingface_hub.WebhookPayload]] + +[[autodoc]] huggingface_hub.WebhookPayload + +### WebhookPayloadComment[[huggingface_hub.WebhookPayloadComment]] + +[[autodoc]] huggingface_hub.WebhookPayloadComment + +### WebhookPayloadDiscussion[[huggingface_hub.WebhookPayloadDiscussion]] + +[[autodoc]] huggingface_hub.WebhookPayloadDiscussion + +### WebhookPayloadDiscussionChanges[[huggingface_hub.WebhookPayloadDiscussionChanges]] + +[[autodoc]] huggingface_hub.WebhookPayloadDiscussionChanges + +### WebhookPayloadEvent[[huggingface_hub.WebhookPayloadEvent]] + +[[autodoc]] huggingface_hub.WebhookPayloadEvent + +### WebhookPayloadMovedTo[[huggingface_hub.WebhookPayloadMovedTo]] + +[[autodoc]] huggingface_hub.WebhookPayloadMovedTo + +### WebhookPayloadRepo[[huggingface_hub.WebhookPayloadRepo]] + +[[autodoc]] huggingface_hub.WebhookPayloadRepo + +### WebhookPayloadUrl[[huggingface_hub.WebhookPayloadUrl]] + +[[autodoc]] huggingface_hub.WebhookPayloadUrl + +### WebhookPayloadWebhook[[huggingface_hub.WebhookPayloadWebhook]] + +[[autodoc]] huggingface_hub.WebhookPayloadWebhook