Getting started

0. Introduction

---

SaigeToolkit은 SAIGE 연구소에서 공동으로 개발하여 사용하는 프로젝트입니다.

• SaigeToolkit에서 제공하는 API는 "API Reference"에서 확인할 수 있습니다.
• 여러 기술에서 공통적으로 사용되는 기능들이 구현되어 있습니다. 구현된 기능들은 "Code Reference" 에서 확인할 수 있습니다.
• 벤치마크와 같은 실험에서 사용될 기능들은 ResearchToolkit에 구현되어 있습니다.구현된 기능들은 docs의 {version}/ResearchToolkit에서 확인할 수 있습니다.

환경

python=3.11

1. For Users

---

설치

SaigeToolkit은 pip install을 통해 패키지로 설치하여 사용할 수 있습니다. 이때, SaigeToolkit을 사용하기 위해 필요한 requirments들도 같이 설치됩니다.

pip install git+https://dev.azure.com/SaigeResearch/Research/_git/SaigeToolkit@{commit}

아래와 같은 추가 설정을 하여 cythonize된 패키지로 설치할 수 있습니다. 이 경우는, ResearchToolkit을 제외한 SaigeToolkit만 설치됩니다.

PACKAGEMODE=Deploy pip install git+https://dev.azure.com/SaigeResearch/Research/_git/SaigeToolkit@{commit}

설치에 대한 자세한 내용은 Installation guide를 참고해주세요.

Python API 테스트

API 테스트를 통해 환경과 패키지가 제대로 설치 되었는지 확인합니다.

pytest $(ls test/*_api.py)

패키지 사용

설치한 SaigeToolkit 패키지는 아래와 같이 import하여 사용할 수 있습니다.

from SaigeToolkit.learning.trainer import BaseTrainer
...

유의 사항

SaigeToolkit을 사용해서 기술(CLS, SEG, 등)을 개발할 경우, 아래의 유의할 사항을 참고해주세요.

• Usage guide

2. For Developers

---

SaigeToolkit을 개발할 경우, 아래의 가이드를 참고해주세요.

• SaigeToolkit Guide