# 실험 트래커

## GeneralTracker[[accelerate.tracking.GeneralTracker]]

#### accelerate.tracking.GeneralTracker[[accelerate.tracking.GeneralTracker]]

```python
accelerate.tracking.GeneralTracker(_blank = False)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L103)

모든 로깅 통합 구현에 사용할 기본 Tracker 클래스입니다.

각 함수는 [Accelerator](/docs/accelerate/v1.16.0/ko/package_reference/accelerator#accelerate.Accelerator)에 제공된 기본 사전(base dictionary)에서 자동으로 전달되는 `**kwargs`를 입력으로 받아야 합니다.

다음과 같이 `name`, `requires_logging_directory`, `tracker` 속성을 구현해야 합니다:

`name` (`str`): "TensorBoard"와 같은 트래커 클래스 이름의 문자열 표현 `requires_logging_directory` (`bool`): 로거가 로그를 저장하는 데 디렉터리가 필요한지 여부 `tracker` (`object`): 트래커 클래스가 사용하는 내부 추적 메커니즘(예: wandb의 `run`)을 반환해야 합니다

구현에는 관련 로깅, 초기화 및 기타 함수가 메인 프로세스에서 실행될지 아니면 모든 프로세스에서 실행될지를 전환하기 위해 `main_process_only` (`bool`) 속성을 포함할 수도 있습니다(기본값은 `True`입니다).

#### 완료[[accelerate.tracking.GeneralTracker.finish]]

```python
finish()
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L173)

내에서 모든 최종화 함수를 실행해야 합니다. API에 해당 함수가 없다면 해당 메서드를 오버라이드하지 않으면 됩니다.

#### 로그[[accelerate.tracking.GeneralTracker.log]]

```python
log(values: dict, step: int | None = None, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L161)

**매개변수:**

values (Dictionary `str` to `str`, `float`, or `int`) : 키-값 쌍으로 기록될 값. 값의 유형은 `str`, `float`, 또는 `int`여야 합니다.

step (`int`, *선택 사항*) : 실행 단계입니다. 포함되면 로그는 해당 단계에 연결됩니다.

현재 실행에 `values`를 기록합니다. 추적 API의 기본 `log` 구현과 `step` 파라미터에 대한 특수 동작을 여기에 포함해야 합니다.

#### 시작[[accelerate.tracking.GeneralTracker.start]]

```python
start()
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L144)

InitProcessGroupKwargs보다 PartialState를 초기화하지 않도록 Accelerator 내부의 tracker를 지연 초기화합니다.

#### store_init_configuration[[accelerate.tracking.GeneralTracker.store_init_configuration]]

```python
store_init_configuration(values: dict)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L150)

**매개변수:**

values (Dictionary `str` to `bool`, `str`, `float` or `int`) : 초기 하이퍼파라미터로 저장될 값들을 키-값 쌍으로 나타냅니다. 값의 타입은 `bool`, `str`, `float`, `int`, 또는 `None`이어야 합니다.

실행의 하이퍼파라미터로 `values`를 로그로 기록합니다. 구현에서는 추적 API의 실험 구성 기능을 사용해야 합니다.

## register_tracker_class[[accelerate.tracking.register_tracker_class]]

#### accelerate.tracking.register_tracker_class[[accelerate.tracking.register_tracker_class]]

```python
accelerate.tracking.register_tracker_class(tracker_class: type[accelerate.tracking.GeneralTracker])
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L1264)

**매개변수:**

tracker_class (`GeneralTracker`의 하위 클래스) : 등록할 트래커 클래스입니다. `GeneralTracker`의 하위 클래스여야 하며, 비어 있지 않은 `name` 클래스 속성과 `requires_logging_directory` 클래스 속성을 정의해야 합니다. 이 클래스는 `Accelerator.init_trackers()`에 전달된 `project_name`을 첫 번째 위치 인수로 사용하여 인스턴스화됩니다. `requires_logging_directory`가 `True`인 경우, 로깅 디렉토리가 두 번째 위치 인수로 전달됩니다(내장 트래커의 관례와 일치). `init_kwargs`의 트래커별 키워드 인수는 `**kwargs`로 전달됩니다.

`log_with` 인수의 [Accelerator](/docs/accelerate/v1.16.0/ko/package_reference/accelerator#accelerate.Accelerator)에서 내장된 트래커와 동일한 방식으로 `name`을 통해 참조할 수 있도록 사용자 정의 `GeneralTracker` 하위 클래스를 등록합니다.

이를 사용하는 [Accelerator](/docs/accelerate/v1.16.0/ko/package_reference/accelerator#accelerate.Accelerator)를 인스턴스화하기 전에 트래커를 등록해야 합니다.

예:

```python
from accelerate import Accelerator
from accelerate.tracking import GeneralTracker, register_tracker_class

class MyTracker(GeneralTracker):
    name = "my_tracker"
    requires_logging_directory = False
    # ... implement the rest of the `GeneralTracker` interface

register_tracker_class(MyTracker)
accelerator = Accelerator(log_with="my_tracker")
```

## TensorBoardTracker[[accelerate.tracking.TensorBoardTracker]]

#### accelerate.tracking.TensorBoardTracker[[accelerate.tracking.TensorBoardTracker]]

```python
accelerate.tracking.TensorBoardTracker(run_name: str, logging_dir: str | os.PathLike, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L180)

**매개변수:**

run_name (`str`) : 실험 실행의 이름

logging_dir (`str`, `os.PathLike`) : TensorBoard 로그가 저장될 위치.

- ****kwargs** (추가 키워드 인자, *선택 사항*) : `tensorboard.SummaryWriter.__init__` 메서드로 전달되는 추가 키워드 인자입니다.

`tensorboard`를 지원하는 `Tracker` 클래스입니다. 스크립트의 시작 부분에 초기화해야 합니다.

#### __init__[[accelerate.tracking.TensorBoardTracker.__init__]]

```python
__init__(run_name: str, logging_dir: str | os.PathLike, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L196)

## WandBTracker[[accelerate.tracking.WandBTracker]]

#### accelerate.tracking.WandBTracker[[accelerate.tracking.WandBTracker]]

```python
accelerate.tracking.WandBTracker(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L295)

**매개변수:**

run_name (`str`) : 실험 실행의 이름.

- ****kwargs** (추가 키워드 인자, *선택 사항*) : `wandb.init` 메서드로 전달되는 추가 키워드 인자입니다.

`wandb`를 지원하는 `Tracker` 클래스입니다. 스크립트 시작 시 초기화해야 합니다.

#### __init__[[accelerate.tracking.WandBTracker.__init__]]

```python
__init__(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L310)

## Trackio[[accelerate.tracking.TrackioTracker]]

#### accelerate.tracking.TrackioTracker[[accelerate.tracking.TrackioTracker]]

```python
accelerate.tracking.TrackioTracker(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L420)

**매개변수:**

run_name (`str`) : 실험 실행의 이름입니다. trackio를 인스턴스화할 때 `project` 이름으로 사용됩니다.

- ****kwargs** (추가 키워드 인자, *선택 사항*) : `trackio.init` 메서드로 전달되는 추가 키워드 인자입니다. 지원되는 모든 키워드 인자를 확인하려면 이 [init](https://github.com/gradio-app/trackio/blob/814809552310468b13f84f33764f1369b4e5136c/trackio/__init__.py#L22)를 참조하세요.

`trackio`를 지원하는 `Tracker` 클래스입니다. 스크립트 시작 시 초기화해야 합니다.

#### __init__[[accelerate.tracking.TrackioTracker.__init__]]

```python
__init__(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L437)

## CometMLTracker[[accelerate.tracking.CometMLTracker]]

#### accelerate.tracking.CometMLTracker[[accelerate.tracking.CometMLTracker]]

```python
accelerate.tracking.CometMLTracker(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L497)

**매개변수:**

run_name (`str`) : 실험 실행의 이름.

- ****kwargs** (추가 키워드 인자, *선택 사항*) : `comet_ml.start` 메서드로 전달되는 추가 키워드 인자: https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/start/

`comet_ml`을 지원하는 `Tracker` 클래스입니다. 스크립트의 시작 부분에 초기화해야 합니다.

API 키는 Comet 설정 파일에 저장해야 합니다.

Note: `comet_ml` 버전 3.41.0 미만에서는 추가 키워드 인수가 `comet_ml.Experiment`에 대신 전달됩니다: https://www.comet.com/docs/v2/api-and-sdk/python-sdk/reference/Experiment/#comet_ml.Experiment.__init__

#### __init__[[accelerate.tracking.CometMLTracker.__init__]]

```python
__init__(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L518)

## AimTracker[[accelerate.tracking.AimTracker]]

#### accelerate.tracking.AimTracker[[accelerate.tracking.AimTracker]]

```python
accelerate.tracking.AimTracker(run_name: str, logging_dir: str | os.PathLike | None = '.', **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L591)

**매개변수:**

run_name (`str`) : 실험 실행의 이름.

- ****kwargs** (추가 키워드 인자, *선택 사항*) : `Run.__init__` 메서드로 전달되는 추가 키워드 인자입니다.

`aim`을 지원하는 `Tracker` 클래스입니다. 스크립트 시작 시 초기화해야 합니다.

#### __init__[[accelerate.tracking.AimTracker.__init__]]

```python
__init__(run_name: str, logging_dir: str | os.PathLike | None = '.', **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L605)

## MLflowTracker[[accelerate.tracking.MLflowTracker]]

#### accelerate.tracking.MLflowTracker[[accelerate.tracking.MLflowTracker]]

```python
accelerate.tracking.MLflowTracker(experiment_name: str | None = None, logging_dir: str | os.PathLike | None = None, run_id: str | None = None, tags: dict[str, typing.Any] | str | None = None, nested_run: bool | None = False, run_name: str | None = None, description: str | None = None)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L694)

**매개변수:**

experiment_name (`str`, *선택 사항*) : 실험의 이름. 환경 변수 MLFLOW_EXPERIMENT_NAME이 이 인자보다 우선합니다.

logging_dir (`str` 또는 `os.PathLike`, 기본값 `"."`) : mlflow 로그를 저장할 위치.

run_id (`str`, *선택 사항*) : 지정된 경우, 해당 UUID를 가진 실행을 가져오고 그 실행 아래에 매개변수와 메트릭을 기록합니다. 실행의 종료 시간은 설정되지 않고 상태는 실행 중으로 설정되지만, 실행의 다른 속성(source_version, source_type 등)은 변경되지 않습니다. 환경 변수 MLFLOW_RUN_ID가 이 인자보다 우선합니다.

tags (`Dict[str, str]`, *선택*) : 실행에 태그로 설정할 `str` 키와 값으로 구성된 선택적 `dict` 또는 `dict`에서 `str`로 덤프된 값입니다. 실행이 재개되는 경우, 이 태그는 재개된 실행에 설정됩니다. 새 실행이 생성되는 경우, 이 태그는 새 실행에 설정됩니다. 환경 변수 MLFLOW_TAGS가 이 인자보다 우선합니다.

nested_run (`bool`, *선택 사항*, 기본값 `False`) : 실행이 부모 실행에 중첩되는지 여부를 제어합니다. True를 설정하면 중첩 실행이 생성됩니다. 환경 변수 MLFLOW_NESTED_RUN이 이 인자보다 우선합니다.

run_name (`str`, *선택 사항*) : 새 실행의 이름(mlflow.runName 태그로 저장됨). `run_id`가 지정되지 않은 경우에만 사용됩니다.

description (`str`, *선택 사항*) : 실행의 설명 상자를 채우는 선택적 문자열입니다. 실행을 재개하는 경우, 설명은 재개된 실행에 설정됩니다. 새 실행을 생성하는 경우, 설명은 새 실행에 설정됩니다.

`mlflow`를 지원하는 `Tracker` 클래스입니다. 스크립트 시작 시 초기화해야 합니다.

#### __init__[[accelerate.tracking.MLflowTracker.__init__]]

```python
__init__(experiment_name: str | None = None, logging_dir: str | os.PathLike | None = None, run_id: str | None = None, tags: dict[str, typing.Any] | str | None = None, nested_run: bool | None = False, run_name: str | None = None, description: str | None = None)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L725)

## ClearMLTracker[[accelerate.tracking.ClearMLTracker]]

#### accelerate.tracking.ClearMLTracker[[accelerate.tracking.ClearMLTracker]]

```python
accelerate.tracking.ClearMLTracker(run_name: str | None = None, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L905)

**매개변수:**

run_name (`str`, *선택 사항*) : 실험의 이름. 환경 변수 `CLEARML_PROJECT`와 `CLEARML_TASK`는 이 인자보다 우선합니다.

- ****kwargs** (추가 키워드 인자, *선택 사항*) : `Task.__init__` 메서드로 전달되는 Kwargs입니다.

`clearml`을 지원하는 `Tracker` 클래스입니다. 스크립트 시작 부분에 초기화해야 합니다.

#### __init__[[accelerate.tracking.ClearMLTracker.__init__]]

```python
__init__(run_name: str | None = None, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L920)

## SwanLabTracker[[accelerate.tracking.SwanLabTracker]]

#### accelerate.tracking.SwanLabTracker[[accelerate.tracking.SwanLabTracker]]

```python
accelerate.tracking.SwanLabTracker(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L1151)

**매개변수:**

run_name (`str`) : 실험 실행의 이름.

- ****kwargs** (추가 키워드 인자, *선택 사항*) : `swanlab.init` 메서드로 전달되는 추가 키워드 인자입니다.

`swanlab`를 지원하는 `Tracker` 클래스입니다. 스크립트 시작 시 초기화해야 합니다.

#### __init__[[accelerate.tracking.SwanLabTracker.__init__]]

```python
__init__(run_name: str, **kwargs)
```

[소스](https://github.com/huggingface/accelerate/blob/v1.16.0/src/accelerate/tracking.py#L1166)

