transformers/docs/source/ko/main_classes/callback.md
Shaohon Chen 0440dbc0e1
Integrate SwanLab for offline/online experiment tracking and local visualization (#36433)
* add swanlab integration

* feat(integrate): add SwanLab as an optional experiment tracking tool in transformers

- Integrated SwanLab into the transformers library as an alternative for experiment tracking.
- Users can now log training metrics, hyperparameters, and other experiment details to SwanLab by setting `report_to="swanlab"` in the `TrainingArguments`.
- Added necessary dependencies and documentation for SwanLab integration.

* Fix the spelling error of SwanLabCallback in callback.md

* Apply suggestions from code review

Co-authored-by: Marc Sun <57196510+SunMarc@users.noreply.github.com>

* Fix typo in comment

* Fix typo in comment

* Fix typos and update comments

* fix annotation

* chore: opt some comments

---------

Co-authored-by: Marc Sun <57196510+SunMarc@users.noreply.github.com>
Co-authored-by: AAssets <20010618@qq.com>
Co-authored-by: ZeYi Lin <944270057@qq.com>
Co-authored-by: KAAANG <79990647+SAKURA-CAT@users.noreply.github.com>
2025-03-06 17:35:30 +01:00

5.9 KiB

콜백 callbacks

콜백은 PyTorch [Trainer]의 반복 학습 동작을 사용자 정의할 수 있는 객체입니다 (이 기능은 TensorFlow에서는 아직 구현되지 않았습니다). 콜백은 반복 학습의 상태를 검사하여 (진행 상황 보고, TensorBoard 또는 기타 머신 러닝 플랫폼에 로그 남기기 등) 결정(예: 조기 종료)을 내릴 수 있습니다.

콜백은 [TrainerControl] 객체를 반환하는 것 외에는 반복 학습에서 어떤 것도 변경할 수 없는 "읽기 전용" 코드 조각입니다. 반복 학습에 변경이 필요한 사용자 정의 작업이 필요한 경우, [Trainer]를 서브클래스로 만들어 필요한 메소드들을 오버라이드해야 합니다 (예시는 trainer를 참조하세요).

기본적으로 TrainingArguments.report_to"all"로 설정되어 있으므로, [Trainer]는 다음 콜백을 사용합니다.

  • [DefaultFlowCallback]는 로그, 저장, 평가에 대한 기본 동작을 처리합니다.
  • [PrinterCallback] 또는 [ProgressCallback]는 진행 상황을 표시하고 로그를 출력합니다 ([TrainingArguments]를 통해 tqdm을 비활성화하면 첫 번째 콜백이 사용되고, 그렇지 않으면 두 번째가 사용됩니다).
  • [~integrations.TensorBoardCallback]는 TensorBoard가 (PyTorch >= 1.4 또는 tensorboardX를 통해) 접근 가능하면 사용됩니다.
  • [~integrations.WandbCallback]는 wandb가 설치되어 있으면 사용됩니다.
  • [~integrations.CometCallback]는 comet_ml이 설치되어 있으면 사용됩니다.
  • [~integrations.MLflowCallback]는 mlflow가 설치되어 있으면 사용됩니다.
  • [~integrations.NeptuneCallback]는 neptune이 설치되어 있으면 사용됩니다.
  • [~integrations.AzureMLCallback]는 azureml-sdk가 설치되어 있으면 사용됩니다.
  • [~integrations.CodeCarbonCallback]는 codecarbon이 설치되어 있으면 사용됩니다.
  • [~integrations.ClearMLCallback]는 clearml이 설치되어 있으면 사용됩니다.
  • [~integrations.DagsHubCallback]는 dagshub이 설치되어 있으면 사용됩니다.
  • [~integrations.FlyteCallback]는 flyte가 설치되어 있으면 사용됩니다.
  • [~integrations.DVCLiveCallback]는 dvclive가 설치되어 있으면 사용됩니다.
  • [~integrations.SwanLabCallback]는 swanlab가 설치되어 있으면 사용됩니다.

패키지가 설치되어 있지만 해당 통합 기능을 사용하고 싶지 않다면, TrainingArguments.report_to를 사용하고자 하는 통합 기능 목록으로 변경할 수 있습니다 (예: ["azure_ml", "wandb"]).

콜백을 구현하는 주요 클래스는 [TrainerCallback]입니다. 이 클래스는 [Trainer]를 인스턴스화하는 데 사용된 [TrainingArguments]를 가져오고, 해당 Trainer의 내부 상태를 [TrainerState]를 통해 접근할 수 있으며, [TrainerControl]을 통해 반복 학습에서 일부 작업을 수행할 수 있습니다.

사용 가능한 콜백 available-callbacks

라이브러리에서 사용 가능한 [TrainerCallback] 목록은 다음과 같습니다:

autodoc integrations.CometCallback - setup

autodoc DefaultFlowCallback

autodoc PrinterCallback

autodoc ProgressCallback

autodoc EarlyStoppingCallback

autodoc integrations.TensorBoardCallback

autodoc integrations.WandbCallback - setup

autodoc integrations.MLflowCallback - setup

autodoc integrations.AzureMLCallback

autodoc integrations.CodeCarbonCallback

autodoc integrations.NeptuneCallback

autodoc integrations.ClearMLCallback

autodoc integrations.DagsHubCallback

autodoc integrations.FlyteCallback

autodoc integrations.DVCLiveCallback - setup

autodoc integrations.SwanLabCallback - setup

TrainerCallback trainercallback

autodoc TrainerCallback

여기 PyTorch [Trainer]와 함께 사용자 정의 콜백을 등록하는 예시가 있습니다:

class MyCallback(TrainerCallback):
    "A callback that prints a message at the beginning of training"

    def on_train_begin(self, args, state, control, **kwargs):
        print("Starting training")


trainer = Trainer(
    model,
    args,
    train_dataset=train_dataset,
    eval_dataset=eval_dataset,
    callbacks=[MyCallback],  # 우리는 콜백 클래스를 이 방식으로 전달하거나 그것의 인스턴스(MyCallback())를 전달할 수 있습니다
)

또 다른 콜백을 등록하는 방법은 trainer.add_callback()을 호출하는 것입니다:

trainer = Trainer(...)
trainer.add_callback(MyCallback)
# 다른 방법으로는 콜백 클래스의 인스턴스를 전달할 수 있습니다
trainer.add_callback(MyCallback())

TrainerState trainerstate

autodoc TrainerState

TrainerControl trainercontrol

autodoc TrainerControl