Skip to content

Latest commit

 

History

History
332 lines (210 loc) · 21.5 KB

contributing.md

File metadata and controls

332 lines (210 loc) · 21.5 KB
Raw

🤗 Transformers에 기여하기 [[contribute-to-transformers]]

누구나 🤗 Transformers에 기여할 수 있으며, 우리는 모든 사람의 기여를 소중히 생각합니다. 코드 기여는 커뮤니티를 돕는 유일한 방법이 아닙니다. 질문에 답하거나 다른 사람을 도와 문서를 개선하는 것도 매우 가치가 있습니다.

🤗 Transformers를 널리 알리는 것도 큰 도움이 됩니다! 멋진 프로젝트들을 가능하게 한 🤗 Transformers 라이브러리에 대해 블로그 게시글에 언급하거나, 도움이 되었을 때마다 Twitter에 알리거나, 저장소에 ⭐️ 를 표시하여 감사 인사를 전해주세요.

어떤 방식으로 기여하든 행동 규칙을 숙지하고 존중해주세요.

이 안내서는 멋진 scikit-learn 기여 안내서에서 큰 영감을 받았습니다.

기여하는 방법 [[ways-to-contribute]]

여러 가지 방법으로 🤗 Transformers에 기여할 수 있습니다:

  • 기존 코드의 미해결된 문제를 수정합니다.
  • 버그 또는 새로 추가되길 원하는 기능과 관련된 이슈를 제출합니다.
  • 새로운 모델을 구현합니다.
  • 예제나 문서에 기여합니다.

어디서부터 시작할지 모르겠다면, Good First Issue 목록을 확인해보세요. 이 목록은 초보자도 참여하기 쉬운 오픈 이슈 목록을 제공하며, 당신이 오픈소스에 처음으로 기여하는 데 큰 도움이 될 것입니다. 그저 작업하고 싶은 이슈에 댓글만 달아주면 됩니다.

조금 더 도전적인 작업을 원한다면, Good Second Issue 목록도 확인해보세요. 이미 당신이 잘 하고 있다고 생각되더라도, 한 번 시도해보세요! 우리도 여러분을 도울 것입니다. 🚀

커뮤니티에 이루어지는 모든 기여는 똑같이 소중합니다. 🥰

미해결된 문제 수정하기 [[fixing-outstanding-issues]]

기존 코드에서 발견한 문제점에 대한 해결책이 떠오른 경우, 언제든지 기여를 시작하고 Pull Request를 생성해주세요!

버그 관련 이슈를 제기하거나 새로운 기능 요청하기 [[submitting-a-bugrelated-issue-or-feature-request]]

버그 관련 이슈를 제기하거나 새로운 기능을 요청할 때는 다음 가이드라인을 최대한 준수해주세요. 이렇게 하면 좋은 피드백과 함께 빠르게 답변해 드릴 수 있습니다.

버그를 발견하셨나요? [[did-you-find-a-bug]]

🤗 Transformers 라이브러리는 사용 중에 겪는 문제를 보고해주는 사용자들 덕분에 더욱 견고해지고 신뢰할 수 있게 되었습니다.

이슈를 보고하기 전에, 버그가 이미 보고되지 않았는지 확인해주세요. (GitHub의 이슈 탭 아래의 검색 바를 사용하세요). 이슈는 라이브러리 자체에서 발생한 버그어야 하며, 코드의 다른 부분과 관련된 것이 아니어야 합니다. 버그가 라이브러리의 문제로 발생하였는지 확실하지 않은 경우 먼저 포럼에서 질문해 주세요. 이렇게 하면 일반적인 질문보다 라이브러리와 관련된 문제를 더 빠르게 해결할 수 있습니다.

버그가 이미 보고되지 않았다는 것을 확인했다면, 다음 정보를 포함하여 이슈를 제출해 주세요. 그러면 우리가 빠르게 해결할 수 있습니다:

  • 사용 중인 운영체제 종류와 버전, 그리고 Python, PyTorch 또는 TensorFlow 버전.
  • 버그를 30초 이내로 재현할 수 있는 간단하고 독립적인 코드 스니펫.
  • 예외가 발생한 경우 전체 트레이스백.
  • 스크린샷과 같이 도움이 될 것으로 생각되는 추가 정보를 첨부해 주세요.

운영체제와 소프트웨어 버전을 자동으로 가져오려면 다음 명령을 실행하세요:

transformers-cli env

저장소의 루트 디렉터리에서도 같은 명령을 실행할 수 있습니다:

python src/transformers/commands/transformers_cli.py env

새로운 기능을 원하시나요? [[do-you-want-a-new-feature]]

🤗 Transformers에서 사용하고 싶은 새로운 기능이 있다면, 다음 내용을 포함하여 이슈를 제출해 주세요:

  1. 이 기능이 필요한 이유는 무엇인가요? 라이브러리에 대한 문제나 불만과 관련이 있나요? 프로젝트에 필요한 기능인가요? 커뮤니티에 도움이 될 만한 기능인가요?

    어떤 내용이든 여러분의 이야기를 듣고 싶습니다!

  2. 요청하는 기능을 최대한 자세히 설명해 주세요. 더 많은 정보를 제공할수록 더 나은 도움을 드릴 수 있습니다.

  3. 해당 기능의 사용법을 보여주는 코드 스니펫을 제공해 주세요.

  4. 기능과 관련된 논문이 있는 경우 링크를 포함해 주세요.

이슈가 잘 작성되었다면 이슈가 생성된 순간, 이미 80% 정도의 작업이 완료된 것입니다.

이슈를 제기하는 데 도움이 될 만한 템플릿도 준비되어 있습니다.

새로운 모델을 구현하고 싶으신가요? [[do-you-want-to-implement-a-new-model]]

새로운 모델은 계속해서 출시됩니다. 만약 여러분이 새로운 모델을 구현하고 싶다면 다음 정보를 제공해 주세요:

  • 모델에 대한 간단한 설명과 논문 링크.
  • 구현이 공개되어 있다면 구현 링크.
  • 모델 가중치가 사용 가능하다면 가중치 링크.

만약 모델을 직접 기여하고 싶으시다면, 알려주세요. 🤗 Transformers에 추가할 수 있도록 도와드리겠습니다!

🤗 Transformers에 새로운 모델을 추가하는 방법에 대한 기술적인 안내서도 있습니다.

문서를 추가하고 싶으신가요? [[do-you-want-to-add-documentation]]

우리는 언제나 더 명확하고 정확한 문서를 제공하기 위하여 개선점을 찾고 있습니다. 오탈자나 부족한 내용, 분명하지 않거나 부정확한 내용 등을 알려주시면 개선하는 데 도움이 됩니다. 관심이 있으시다면 변경하거나 기여하실 수 있도록 도와드리겠습니다!

문서를 생성, 빌드 및 작성하는 방법에 대한 자세한 내용은 README 문서를 확인해 주세요.

풀 리퀘스트(Pull Request) 생성하기 [[create-a-pull-request]]

코드를 작성하기 전에 기존의 Pull Request나 이슈를 검색하여 누군가 이미 동일한 작업을 하고 있는지 확인하는 것이 좋습니다. 확실하지 않다면 피드백을 받기 위해 이슈를 열어보는 것이 좋습니다.

🤗 Transformers에 기여하기 위해서는 기본적인 git 사용 능력이 필요합니다. git은 사용하기 쉬운 도구는 아니지만, 매우 훌륭한 매뉴얼을 제공합니다. 쉘(shell)에서 git --help을 입력하여 확인해보세요! 만약 책을 선호한다면, Pro Git은 매우 좋은 참고 자료가 될 것입니다.

🤗 Transformers에 기여하려면 Python 3.8 이상의 버전이 필요합니다. 기여를 시작하려면 다음 단계를 따르세요:

  1. 저장소 페이지에서 Fork 버튼을 클릭하여 저장소를 포크하세요. 이렇게 하면 코드의 복사본이 여러분의 GitHub 사용자 계정 아래에 생성됩니다.

  2. 포크한 저장소를 로컬 디스크로 클론하고, 기본 저장소를 원격(remote)으로 추가하세요:

    git clone git@github.com:<your Github handle>/transformers.git
cd transformers
git remote add upstream https://github.com/huggingface/transformers.git

  3. 개발 변경 사항을 저장할 새 브랜치를 생성하세요:

    git checkout -b a-descriptive-name-for-my-changes

    🚨 절대 main 브랜치에서 작업하지 마세요!

  4. 가상 환경에서 다음 명령을 실행하여 개발 환경을 설정하세요:

    pip install -e ".[dev]"

    만약 이미 가상 환경에 🤗 Transformers가 설치되어 있다면, -e 플래그를 사용하여 설치하기 전에 pip uninstall transformers로 제거해주세요.

    여러분의 운영체제에 따라서, 그리고 🤗 Transformers의 선택적 의존성의 수가 증가하면서, 이 명령이 실패할 수도 있습니다. 그럴 경우 사용하려는 딥러닝 프레임워크(PyTorch, TensorFlow, 그리고/또는 Flax)를 설치한 후 아래 명령을 실행해주세요:

    pip install -e ".[quality]"

    대부분의 경우 이것으로 충분할 것입니다.

  5. 브랜치에서 기능을 개발하세요.

    코드를 작업하는 동안 테스트 스위트(test suite)가 통과하는지 확인하세요. 다음과 같이 변경 사항에 영향을 받는 테스트를 실행하세요:

    pytest tests/<TEST_TO_RUN>.py

    테스트에 대한 더 많은 정보는 테스트 가이드를 확인하세요.

    🤗 Transformers는 black과 ruff를 사용하여 소스 코드의 형식을 일관되게 유지합니다. 변경 사항을 적용한 후에는 다음 명령으로 자동으로 스타일 교정 및 코드 검증을 수행하세요:

    make fixup

    이것은 또한 작업 중인 PR에서 수정한 파일에서만 작동하도록 최적화되어 있습니다.

    검사를 하나씩 실행하려는 경우, 다음 명령으로 스타일 교정을 적용할 수 있습니다:

    make style

    🤗 Transformers는 또한 ruff와 몇 가지 사용자 정의 스크립트를 사용하여 코딩 실수를 확인합니다. CI를 통해 품질 관리가 수행되지만, 다음 명령으로 동일한 검사를 실행할 수 있습니다:

    make quality

    마지막으로, 새 모델을 추가할 때 일부 파일을 업데이트하는 것을 잊지 않도록 하기 위한 많은 스크립트가 있습니다. 다음 명령으로 이러한 스크립트를 실행할 수 있습니다:

    make repo-consistency

    이러한 검사에 대해 자세히 알아보고 관련 문제를 해결하는 방법은 Pull Request에 대한 검사 가이드를 확인하세요.

    만약 docs/source 디렉터리 아래의 문서를 수정하는 경우, 문서가 빌드될 수 있는지 확인하세요. 이 검사는 Pull Request를 열 때도 CI에서 실행됩니다. 로컬 검사를 실행하려면 문서 빌더를 설치해야 합니다:

    pip install ".[docs]"

    저장소의 루트 디렉터리에서 다음 명령을 실행하세요:

    doc-builder build transformers docs/source/en --build_dir ~/tmp/test-build

    이 명령은 ~/tmp/test-build 폴더에 문서를 빌드하며, 생성된 Markdown 파일을 선호하는 편집기로 확인할 수 있습니다. Pull Request를 열 때 GitHub에서 문서를 미리 볼 수도 있습니다.

    변경 사항에 만족하면 git add로 변경된 파일을 추가하고, git commit으로 변경 사항을 로컬에 기록하세요:

    git add modified_file.py
git commit

    좋은 커밋 메시지를 작성하여 변경 사항을 명확하게 전달하세요!

    변경 사항을 프로젝트 원본 저장소와 동기화하려면, PR을 열기 전에 브랜치를 upstream/branch로 리베이스(rebase)하세요. 또는 관리자의 요청에 이 작업이 필요할 수 있습니다:

    git fetch upstream
git rebase upstream/main

    변경 사항을 브랜치에 푸시하세요:

    git push -u origin a-descriptive-name-for-my-changes

    이미 PR을 열었다면, --force 플래그와 함께 강제 푸시해야 합니다. 아직 PR이 열리지 않았다면 정상적으로 변경 사항을 푸시하면 됩니다.

  6. 이제 GitHub에서 포크한 저장소로 이동하고 **Pull request(풀 리퀘스트)**를 클릭하여 Pull Request를 열 수 있습니다. 아래의 체크리스트에서 모든 항목에 체크 표시를 하세요. 준비가 완료되면 프로젝트 관리자에게 변경 사항을 보내 검토를 요청할 수 있습니다.

  7. 관리자가 변경 사항을 요청해도 괜찮습니다. 핵심 기여자들도 동일한 상황을 겪습니다! 모두가 변경 사항을 Pull Request에서 볼 수 있도록, 로컬 브랜치에서 작업하고 변경 사항을 포크한 저장소로 푸시하세요. 그러면 변경 사항이 자동으로 Pull Request에 나타납니다.

Pull Request 체크리스트 [[pull-request-checklist]]

☐ Pull Request 제목은 기여 내용을 요약해야 합니다.
☐ Pull Request가 이슈를 해결하는 경우, Pull Request 설명에 이슈 번호를 언급하여 연관되어 있음을 알려주세요. (이슈를 확인하는 사람들이 해당 이슈에 대한 작업이 진행 중임을 알 수 있게 합니다).
☐ 작업이 진행중이라면 제목 앞에 [WIP]를 붙여주세요. 중복 작업을 피하고 병합할 준비가 된 PR과 구분하기에 유용합니다.
☐ 기존 테스트를 통과하는지 확인하세요.
☐ 새로운 기능을 추가하는 경우, 해당 기능에 대한 테스트도 추가하세요.

  • 새 모델을 추가하는 경우, ModelTester.all_model_classes = (MyModel, MyModelWithLMHead,...)을 사용하여 일반적인 테스트를 활성화하세요.
  • 새 @slow 테스트를 추가하는 경우, 다음 명령으로 테스트를 통과하는지 확인하세요: RUN_SLOW=1 python -m pytest tests/models/my_new_model/test_my_new_model.py.
  • 새 토크나이저를 추가하는 경우, 테스트를 작성하고 다음 명령으로 테스트를 통과하는지 확인하세요: RUN_SLOW=1 python -m pytest tests/models/{your_model_name}/test_tokenization_{your_model_name}.py.
  • CircleCI에서는 느린 테스트를 실행하지 않지만, GitHub Actions에서는 매일 밤 실행됩니다!

☐ 모든 공개 메소드는 유용한 기술문서를 가져야 합니다 (예를 들어 modeling_bert.py 참조).
☐ 저장소가 빠르게 성장하고 있으므로 저장소에 상당한 부담을 주는 이미지, 동영상 및 기타 텍스트가 아닌 파일은 추가하지 마세요. 대신 hf-internal-testing과 같은 Hub 저장소를 사용하여 이러한 파일을 호스팅하고 URL로 참조하세요. 문서와 관련된 이미지는 다음 저장소에 배치하는 것을 권장합니다: huggingface/documentation-images. 이 데이터셋 저장소에서 PR을 열어서 Hugging Face 멤버에게 병합을 요청할 수 있습니다.

Pull Request에서 실행되는 검사에 대한 자세한 정보는 Pull Request에 대한 검사 가이드를 확인하세요.

테스트 [[tests]]

라이브러리 동작과 여러 예제를 테스트할 수 있는 광범위한 테스트 스위트가 포함되어 있습니다. 라이브러리 테스트는 tests 폴더에, 예제 테스트는 examples 폴더에 있습니다.

속도가 빠른 pytest와 pytest-xdist를 선호합니다. 저장소의 루트 디렉터리에서 테스트를 실행할 하위 폴더 경로 또는 테스트 파일 경로를 지정하세요:

python -m pytest -n auto --dist=loadfile -s -v ./tests/models/my_new_model

마찬가지로 examples 디렉터리에서도 하위 폴더 경로 또는 테스트 파일 경로를 지정하세요. 예를 들어, 다음 명령은 PyTorch examples 디렉터리의 텍스트 분류 하위 폴더를 테스트합니다:

pip install -r examples/xxx/requirements.txt  # only needed the first time
python -m pytest -n auto --dist=loadfile -s -v ./examples/pytorch/text-classification

이것이 실제로 make test 및 make test-examples 명령이 구현되는 방식입니다 (pip install은 제외합니다)!

또한 특정 기능만 테스트하기 위한 더 작은 테스트를 지정할 수 있습니다.

기본적으로 느린 테스트는 건너뛰지만 RUN_SLOW 환경 변수를 yes로 설정하여 실행할 수 있습니다. 이렇게 하면 많은 기가바이트 단위의 모델이 다운로드되므로 충분한 디스크 공간, 좋은 인터넷 연결과 많은 인내가 필요합니다!

테스트를 실행하려면 하위 폴더 경로 또는 테스트 파일 경로를 지정하세요. 그렇지 않으면 tests 또는 examples 폴더의 모든 테스트를 실행하게 되어 매우 긴 시간이 걸립니다!

RUN_SLOW=yes python -m pytest -n auto --dist=loadfile -s -v ./tests/models/my_new_model
RUN_SLOW=yes python -m pytest -n auto --dist=loadfile -s -v ./examples/pytorch/text-classification

느린 테스트와 마찬가지로, 다음과 같이 테스트 중에 기본적으로 활성화되지 않는 다른 환경 변수도 있습니다:

  • RUN_CUSTOM_TOKENIZERS: 사용자 정의 토크나이저 테스트를 활성화합니다.
  • RUN_PT_FLAX_CROSS_TESTS: PyTorch + Flax 통합 테스트를 활성화합니다.
  • RUN_PT_TF_CROSS_TESTS: TensorFlow + PyTorch 통합 테스트를 활성화합니다.

더 많은 환경 변수와 추가 정보는 testing_utils.py에서 찾을 수 있습니다.

🤗 Transformers는 테스트 실행기로 pytest를 사용합니다. 그러나 테스트 스위트 자체에서는 pytest 관련 기능을 사용하지 않습니다.

이것은 unittest가 완전히 지원된다는 것을 의미합니다. 다음은 unittest로 테스트를 실행하는 방법입니다:

python -m unittest discover -s tests -t . -v
python -m unittest discover -s examples -t examples -v

스타일 가이드 [[style-guide]]

문서는 Google Python 스타일 가이드를 따릅니다. 자세한 정보는 문서 작성 가이드를 확인하세요.

Windows에서 개발 [[develop-on-windows]]

Windows에서 개발할 경우(Windows Subsystem for Linux 또는 WSL에서 작업하지 않는 한) Windows CRLF 줄 바꿈을 Linux LF 줄 바꿈으로 변환하도록 git을 구성해야 합니다:

git config core.autocrlf input

Windows에서 make 명령을 실행하는 한 가지 방법은 MSYS2를 사용하는 것입니다:

  1. MSYS2를 다운로드합니다. C:\msys64에 설치되었다고 가정합니다.
  2. CLI에서 C:\msys64\msys2.exe를 엽니다 (시작 메뉴에서 사용 가능해야 함).
  3. 쉘에서 다음을 실행하여: pacman -Syu 및 pacman -S make로 make를 설치합니다.
  4. 환경 변수 PATH에 C:\msys64\usr\bin을 추가하세요.

이제 모든 터미널 (PowerShell, cmd.exe 등)에서 make를 사용할 수 있습니다! 🎉

포크한 저장소를 상위 원본 브랜치(main)과 동기화하기 (Hugging Face 저장소) [[sync-a-forked-repository-with-upstream-main-the-hugging-face-repository]]

포크한 저장소의 main 브랜치를 업데이트할 때, 다음 단계를 따라 수행해주세요. 이렇게 하면 각 upstream PR에 참조 노트가 추가되는 것을 피하고 이러한 PR에 관여하는 개발자들에게 불필요한 알림이 전송되는 것을 방지할 수 있습니다.

  1. 가능하면 포크된 저장소의 브랜치 및 PR을 사용하여 upstream과 동기화하지 마세요. 대신 포크된 main 저장소에 직접 병합하세요.

  2. PR이 반드시 필요한 경우, 브랜치를 확인한 후 다음 단계를 사용하세요:

    git checkout -b your-branch-for-syncing
git pull --squash --no-commit upstream main
git commit -m '<your message without GitHub references>'
git push --set-upstream origin your-branch-for-syncing