[l10n] HF Transformers 번역 가이드

Pseudo Lab의 이니셔티브로 HF Transformers 의 번역이 23/03/23부터 23/07/08까지 진행됩니다. 팀원을 위해 경험 공유와 함께 말미암은 전체적인 번역 과정을 소개해볼게요.

번역 과정

번역할 영어 *.mdx 문서를 ko 디렉터리로 들고온 뒤, _toctree.yml (Table of Contents Tree; 목차)에 추가하세요.
한국어로 번역할 때 주의할 점은 크게 3가지입니다.
1. 제품명은 번역하지 않습니다. (헷갈린다면 앞에 '🤗'가 있는지 확인해주세요)
  transformers 같은 모델 아키텍처 또는 backpropagation 등 ML 관련 단어는 번역해도 됩니다. 다만 통일되지 않은 용어도 많아서 OT에서 말씀하신대로 이런 단어들은 카톡에서 투표를 하고, 용어사전(구글 시트)에 저장해놓을 것 같습니다.
  일단 glossary.mdx 파일을 번역해놓고, 포함된 용어들을 구글 시트에 올려 공유해드리겠습니다.
2. 코드도 마찬가지로 번역하지 않습니다.
  주석은 번역해도 되지만, HuggingFace 문서의 코드 블럭은 대부분 번역이 쉽도록 주석이 없습니다.
3. 번역기를 사용하신 후 문장기호와 조사를 확인해주세요.
  파파고나 DeepL에 .mdx 파일의 내용을 직접 입력하면 종종 문장기호나 조사가 엉뚱한 곳에 나타납니다. 때문에 공식 문서에서 영어 제목을 검색해 되도록 보이는 아스키 문자만 번역기에 넣으시는 것을 추천드립니다.
번역을 마치면 PR을 해주세요. 이때 git rebase -i를 꼭 해서 충돌이 일어나지 않게 해야 합니다.
HuggingFace의 리뷰는 3-20일 정도 소요되지만, 오히려 작업을 다시 살펴볼 기회로 생각하면 좋습니다. PR만의 기술문서 사이트가 생성되면 꼭 마지막 체크를 해주세요.

💡이때 오른쪽의 목차가 잘 작동하는지 한번만 확인 부탁드립니다.

경험 공유

작년 Transformers와 Course의 한국어 번역을 위해 초기 설정 중:

번역본을 모아놓은 <repo>/docs/source/ko가 웹사이트에 반영되지 않았어요. -> 처음 지목된 이유였던 _toctree.yml은 문제 없었고, 다른 언어의 PR을 참고해서 .github/workflows를 수정해 문제를 해결했습니다.

💡관심있으신 팀원께서 해당 부분을 TRANSLATING.md(공식 번역 가이드)에 반영하는 PR을 하셔도 좋을 것 같아요. 혹시 같이 공저하실 분 있으신가요..?

데스크탑 창의 오른쪽에 표시되는 문서 내 목차가 있습니다. 영어가 들어가지 않은 머리말은 반영되지 않았어요. -> doc_builder로 문서가 생성됨을 확인, huggingface/course의 경우 직접 했지만 sed 같은 다른 방법이 있을 것 같습니다.
일단 huggingface/transformers는 번역할 때 아래 코드를 실행 중인 터미널을 띄워놓고 작업 중입니다.

while True:
    print("[[",
          # remove all non-alphanueric characters and join by dashes
          "-".join([
              "".join([c for c in word if c.isalnum() or c == '-'])
              for word in input().strip().lower().split()
          ]).replace('--', '-')[1:], # remove the first and double dashes
          "]]", sep="")

HuggingFace의 문서 리뷰어인 @sgugger님, @ArthurZucker님, @eunseojo님과 리뷰를 하며 느꼈던 점은:

정말 친절합니다. 새해 인사도 주고받고 재밌었어요. 그리고 줄마다 단어가 중복되지 않았는지, 코드가 누락되지 않았는지 꼼꼼하게 보셔서 서식적인 부분은 걱정 안하셔도 좋습니다.
다만 번역의 품질 부분은 Pseudo Lab 자체적으로 검토해야 합니다. 한국인으로 추정되는 @eunseojo님은 바쁘신지 아직 뵙질 못했기 때문입니다. 이번 6기 빌더이신 GH님이 OT 이후에 말씀하셨던 리뷰 프로세스를 설명해주시면 좋을 것 같아요!