> ## Documentation Index
> Fetch the complete documentation index at: https://wb-21fd5541-dependabot-github-actions-actions-cache-6.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# TensorBoard

> 클라우드 기반 시각화, 공유, 그리고 시스템 메트릭과 함께 중앙에서 분석할 수 있도록 TensorBoard 로그를 W&B와 동기화합니다.

export const ColabLink = ({url}) => <a href={url} target="_blank" rel="noopener noreferrer" className="colab-link">
    <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
      <path d="M14.25.18l.9.2.73.26.59.3.45.32.34.34.25.34.16.33.1.3.04.26.02.2-.01.13V8.5l-.05.63-.13.55-.21.46-.26.38-.3.31-.33.25-.35.19-.35.14-.33.1-.3.07-.26.04-.21.02H8.77l-.69.05-.59.14-.5.22-.41.27-.33.32-.27.35-.2.36-.15.37-.1.35-.07.32-.04.27-.02.21v3.06H3.17l-.21-.03-.28-.07-.32-.12-.35-.18-.36-.26-.36-.36-.35-.46-.32-.59-.28-.73-.21-.88-.14-1.05-.05-1.23.06-1.22.16-1.04.24-.87.32-.71.36-.57.4-.44.42-.33.42-.24.4-.16.36-.1.32-.05.24-.01h.16l.06.01h8.16v-.83H6.18l-.01-2.75-.02-.37.05-.34.11-.31.17-.28.25-.26.31-.23.38-.2.44-.18.51-.15.58-.12.64-.1.71-.06.77-.04.84-.02 1.27.05zm-6.3 1.98l-.23.33-.08.41.08.41.23.34.33.22.41.09.41-.09.33-.22.23-.34.08-.41-.08-.41-.23-.33-.33-.22-.41-.09-.41.09zm13.09 3.95l.28.06.32.12.35.18.36.27.36.35.35.47.32.59.28.73.21.88.14 1.04.05 1.23-.06 1.23-.16 1.04-.24.86-.32.71-.36.57-.4.45-.42.33-.42.24-.4.16-.36.09-.32.05-.24.02-.16-.01h-8.22v.82h5.84l.01 2.76.02.36-.05.34-.11.31-.17.29-.25.25-.31.24-.38.2-.44.17-.51.15-.58.13-.64.09-.71.07-.77.04-.84.01-1.27-.04-1.07-.14-.9-.2-.73-.25-.59-.3-.45-.33-.34-.34-.25-.34-.16-.33-.1-.3-.04-.25-.02-.2.01-.13v-5.34l.05-.64.13-.54.21-.46.26-.38.3-.32.33-.24.35-.2.35-.14.33-.1.3-.06.26-.04.21-.02.13-.01h5.84l.69-.05.59-.14.5-.21.41-.28.33-.32.27-.35.2-.36.15-.36.1-.35.07-.32.04-.28.02-.21V6.07h2.09l.14.01.21.03zm-6.47 14.25l-.23.33-.08.41.08.41.23.33.33.23.41.08.41-.08.33-.23.23-.33.08-.41-.08-.41-.23-.33-.33-.23-.41-.08-.41.08z" />
    </svg>
    Colab에서 사용해 보기
  </a>;

<ColabLink url="https://colab.research.google.com/github/wandb/examples/blob/master/colabs/tensorboard/TensorBoard_and_Weights_and_Biases.ipynb" />

<Note>
  W\&B Multi-tenant Cloud에서는 임베디드 TensorBoard를 지원합니다.
</Note>

TensorBoard 로그를 클라우드에 업로드하고, 동료 및 반 친구들과 결과를 빠르게 공유하고, 분석을 한곳에 모아 관리하세요.

<Frame>
  <img src="https://mintcdn.com/wb-21fd5541-dependabot-github-actions-actions-cache-6/YBe_izfYs-9FeLxI/images/integrations/tensorboard_oneline_code.webp?fit=max&auto=format&n=YBe_izfYs-9FeLxI&q=85&s=782d4d5770cfa9efa22eaefe6e88ea1e" alt="TensorBoard 인테그레이션 코드" width="1510" height="1592" data-path="images/integrations/tensorboard_oneline_code.webp" />
</Frame>

<div id="get-started">
  ## 시작하기
</div>

```python theme={null}
import wandb

# `sync_tensorboard=True`로 wandb run 시작
wandb.init(project="my-project", sync_tensorboard=True) as run:
  # TensorBoard를 사용하는 트레이닝 코드
  ...

```

[예제 TensorBoard 인테그레이션 run](https://wandb.ai/rymc/simple-tensorboard-example/runs/oab614zf/tensorboard)을 살펴보세요.

run이 완료되면 W\&B에서 TensorBoard 이벤트 파일에 액세스할 수 있으며, 시스템의 CPU 또는 GPU 사용량, `git` 상태, run에 사용된 터미널 명령 등 유용한 추가 정보와 함께 W\&B 기본 차트에서 메트릭을 시각화할 수 있습니다.

<Note>W\&B는 모든 버전의 TensorFlow에서 TensorBoard를 지원합니다. 또한 PyTorch 및 TensorBoardX와 함께 TensorBoard 1.14 이상도 지원합니다.</Note>

<div id="frequently-asked-questions">
  ## 자주 묻는 질문
</div>

<div id="how-can-i-log-metrics-to-wb-that-arent-logged-to-tensorboard">
  ### TensorBoard에 로깅되지 않는 메트릭을 W\&B에 어떻게 로깅하나요?
</div>

TensorBoard에 로깅되지 않는 추가 커스텀 메트릭을 로깅해야 한다면, 코드에서 `wandb.Run.log()`를 호출하면 됩니다. `run.log({"custom": 0.8})`

TensorBoard를 동기화할 때는 `run.log()`에서 step 인자를 설정하는 기능이 비활성화됩니다. 다른 step 값을 설정하려면 다음과 같이 step 메트릭과 함께 메트릭을 로깅할 수 있습니다.

`run.log({"custom": 0.8, "global_step": global_step})`

<div id="how-do-i-configure-tensorboard-when-im-using-it-with-wandb">
  ### `wandb`와 함께 사용할 때 TensorBoard를 어떻게 설정하나요?
</div>

TensorBoard 패치 방식을 더 세밀하게 제어하려면 `wandb.init()`에 `sync_tensorboard=True`를 전달하는 대신 `wandb.tensorboard.patch()`를 호출하세요.

```python theme={null}
import wandb

wandb.tensorboard.patch(root_logdir="<logging_directory>")
run = wandb.init()

# wandb run을 완료하여 tensorboard 로그를 W&B에 업로드합니다 (Notebook에서 실행 중인 경우)
run.finish()
```

이 방법에 `tensorboard_x=False`를 전달하면 기본 TensorBoard가 패치되도록 할 수 있습니다. PyTorch와 함께 TensorBoard > 1.14를 사용하는 경우에는 `pytorch=True`를 전달해 패치되도록 할 수 있습니다. 두 옵션 모두 임포트된 라이브러리 버전에 따라 적절한 기본값이 자동으로 적용됩니다.

기본적으로 `tfevents` 파일과 모든 `.pbtxt` 파일도 동기화합니다. 이를 통해 W\&B가 사용자를 대신해 TensorBoard 인스턴스를 실행할 수 있습니다. run 페이지에 [TensorBoard 탭](https://www.wandb.com/articles/hosted-tensorboard)이 표시됩니다. 이 동작은 `wandb.tensorboard.patch`에 `save=False`를 전달해 비활성화할 수 있습니다.

```python theme={null}
import wandb

run = wandb.init()
wandb.tensorboard.patch(save=False, tensorboard_x=True)

# 노트북에서 실행 중인 경우, tensorboard 로그를 W&B에 업로드하려면 wandb run을 종료하세요
run.finish()
```

<Warning>
  `tf.summary.create_file_writer()`를 호출하거나 `torch.utils.tensorboard`를 통해 `SummaryWriter`를 생성하기 **전에** 반드시 `wandb.init()` 또는 `wandb.tensorboard.patch()` 중 하나를 호출해야 합니다.
</Warning>

<div id="how-do-i-sync-historical-tensorboard-runs">
  ### 과거 TensorBoard run은 어떻게 동기화하나요?
</div>

로컬에 저장된 기존 `tfevents` 파일이 있고 이를 W\&B로 임포트하려면 `wandb sync log_dir`를 실행하면 됩니다. 여기서 `log_dir`는 `tfevents` 파일이 들어 있는 로컬 디렉터리입니다.

<div id="how-do-i-use-google-colab-or-jupyter-with-tensorboard">
  ### Google Colab 또는 Jupyter에서 TensorBoard를 어떻게 사용하나요?
</div>

Jupyter 또는 Colab 노트북에서 코드를 실행하는 경우, 트레이닝이 끝날 때 `wandb.Run.finish()`를 반드시 호출하세요. 그러면 wandb run이 종료되고 TensorBoard 로그가 W\&B에 업로드되어 시각화할 수 있습니다. 반면 `.py` 스크립트를 실행할 때는 스크립트가 끝나면 wandb가 자동으로 종료되므로 이 작업은 필요하지 않습니다.

노트북 환경에서 셸 명령어를 실행하려면 `!wandb sync directoryname`처럼 앞에 `!`를 붙여야 합니다.

<div id="how-do-i-use-pytorch-with-tensorboard">
  ### TensorBoard와 함께 PyTorch를 사용하려면 어떻게 해야 하나요?
</div>

PyTorch의 TensorBoard 인테그레이션을 사용하는 경우, PyTorch Profiler JSON 파일을 수동으로 업로드해야 할 수 있습니다.

```python theme={null}
with wandb.init(project="my-project", sync_tensorboard=True) as run:
    run.save(glob.glob(f"runs/*.pt.trace.json")[0], base_path=f"runs")
```

<div id="can-i-sync-tfevents-files-stored-in-the-cloud">
  ### 클라우드에 저장된 tfevents 파일을 동기화할 수 있나요?
</div>

`wandb` 0.20.0 이상에서는 S3, GCS 또는 Azure에 저장된 `tfevents` 파일의 동기화를 지원합니다. `wandb`는 각 클라우드 제공업체에 대해 아래 표의 명령으로 설정한 기본 자격 증명을 사용합니다.

| 클라우드 제공업체 | 자격 증명                                   | 로깅 디렉터리 형식                            |
| --------- | --------------------------------------- | ------------------------------------- |
| S3        | `aws configure`                         | `s3://bucket/path/to/logs`            |
| GCS       | `gcloud auth application-default login` | `gs://bucket/path/to/logs`            |
| Azure     | `az login`[^1]                          | `az://account/container/path/to/logs` |

[^1]: `AZURE_STORAGE_ACCOUNT` 및 `AZURE_STORAGE_KEY` 환경 변수도 설정해야 합니다.
