Skip to content

Commit 41e2948

Browse files
authored
[DOCS-1686] Move System Metrics reference out of Models app settings (#1505)
[DOCS-1686] Move System Metrics reference out of Models app settings - Move page, change parent - Update links - Add redirects - Adjust links from a few Japanese and Korean pages to the system metrics page from relrefs to Markdown links so that they continue to work until the Japanese and Korean content catches up.
1 parent ff9706b commit 41e2948

14 files changed

+36
-24
lines changed

content/en/guides/core/automations/automation-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ Because run status is a property of the entire run, you can create a run status
7474
Currently available only in [W&B Multi-tenant Cloud]({{< relref "/guides/hosting/#wb-multi-tenant-cloud" >}}).
7575
{{% /alert %}}
7676

77-
Trigger a workflow based on a logged value for a metric, either a metric in a run's history or a [system metric]({{< relref "/guides/models/app/settings-page/system-metrics.md" >}}) such as `cpu`, which tracks the percentage of CPU utilization. W&B logs system metrics automatically every 15 seconds.
77+
Trigger a workflow based on a logged value for a metric, either a metric in a run's history or a [system metric]({{< relref "/ref/system-metrics.md" >}}) such as `cpu`, which tracks the percentage of CPU utilization. W&B logs system metrics automatically every 15 seconds.
7878

7979
You can create a run metrics automation from the project's **Automations** tab or directly from a line plot panel in a workspace.
8080

content/en/guides/integrations/lightning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,7 @@ The core integration is based on the [Lightning `loggers` API](https://pytorch-l
644644
645645
### What does the integration log without any additional code?
646646
647-
We'll save your model checkpoints to W&B, where you can view them or download them for use in future runs. We'll also capture [system metrics]({{< relref "/guides/models/app/settings-page/system-metrics.md" >}}), like GPU usage and network I/O, environment information, like hardware and OS information, [code state]({{< relref "/guides/models/app/features/panels/code.md" >}}) (including git commit and diff patch, notebook contents and session history), and anything printed to the standard out.
647+
We'll save your model checkpoints to W&B, where you can view them or download them for use in future runs. We'll also capture [system metrics]({{< relref "/ref/system-metrics.md" >}}), like GPU usage and network I/O, environment information, like hardware and OS information, [code state]({{< relref "/guides/models/app/features/panels/code.md" >}}) (including git commit and diff patch, notebook contents and session history), and anything printed to the standard out.
648648
649649
### What if I need to use `wandb.run` in my training setup?
650650

content/en/ref/_index.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,25 @@ no_list: true
4747
</a>
4848
<p className="card-content">A beta JavaScript/TypeScript client to track metrics from your Node server.</p>
4949
{{< /card >}}
50+
{{< card >}}
51+
<a href="./system-metrics/">
52+
<h2 className="card-title">System Metrics</h2>
53+
</a>
54+
<p className="card-content">Metrics automatically logged by W&B, including CPU, memory, disk, network, and GPU usage.</p>
55+
{{< /card >}}
56+
{{< /cardpane >}}
57+
58+
{{< cardpane >}}
5059
{{< card >}}
5160
<a href="./query-panel/">
5261
<h2 className="card-title">Query Panels</h2>
5362
</a>
5463
<p className="card-content"> A beta query language to select and aggregate data.</p>
5564
{{< /card >}}
65+
{{< card >}}
66+
<a href="https://weave-docs.wandb.ai/">
67+
<h2 className="card-title">W&B Weave</h2>
68+
</a>
69+
<p className="card-content">Looking for Weave API? See the <a href="https://weave-docs.wandb.ai/">W&B Weave Docs</a>.</p>
70+
{{< /card >}}
5671
{{< /cardpane >}}
57-
58-
{{% alert %}}
59-
Looking for Weave API? See the [W&B Weave Docs](https://weave-docs.wandb.ai/).
60-
{{% /alert %}}
Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
description: Metrics automatically logged by W&B.
33
menu:
4-
default:
4+
reference:
55
identifier: system-metrics
6-
parent: settings
6+
parent: reference
77
title: System metrics
8-
weight: 70
8+
weight: 50
99
---
1010

1111
This page provides detailed information about the system metrics that are tracked by the W&B SDK.
@@ -147,35 +147,35 @@ W&B assigns a `gpu.{gpu_index}.powerPercent` tag to this metric.
147147
### GPU SM Clock Speed
148148
Represents the clock speed of the Streaming Multiprocessor (SM) on the GPU in MHz. This metric is indicative of the processing speed within the GPU cores responsible for computation tasks.
149149

150-
W&B assigns a `gpu.{gpu_index}.smClock` tag to this metric.
150+
W&B assigns a `gpu.{gpu_index}.smClock` tag to this metric.
151151

152152
### GPU Memory Clock Speed
153153
Represents the clock speed of the GPU memory in MHz, which influences the rate of data transfer between the GPU memory and processing cores.
154154

155-
W&B assigns a `gpu.{gpu_index}.memoryClock` tag to this metric.
155+
W&B assigns a `gpu.{gpu_index}.memoryClock` tag to this metric.
156156

157157
### GPU Graphics Clock Speed
158158

159159
Represents the base clock speed for graphics rendering operations on the GPU, expressed in MHz. This metric often reflects performance during visualization or rendering tasks.
160160

161-
W&B assigns a `gpu.{gpu_index}.graphicsClock` tag to this metric.
161+
W&B assigns a `gpu.{gpu_index}.graphicsClock` tag to this metric.
162162

163163
### GPU Corrected Memory Errors
164164

165165
Tracks the count of memory errors on the GPU that W&B automatically corrects by error-checking protocols, indicating recoverable hardware issues.
166166

167-
W&B assigns a `gpu.{gpu_index}.correctedMemoryErrors` tag to this metric.
167+
W&B assigns a `gpu.{gpu_index}.correctedMemoryErrors` tag to this metric.
168168

169169
### GPU Uncorrected Memory Errors
170170
Tracks the count of memory errors on the GPU that W&B uncorrected, indicating non-recoverable errors which can impact processing reliability.
171171

172-
W&B assigns a `gpu.{gpu_index}.unCorrectedMemoryErrors` tag to this metric.
172+
W&B assigns a `gpu.{gpu_index}.unCorrectedMemoryErrors` tag to this metric.
173173

174174
### GPU Encoder Utilization
175175

176176
Represents the percentage utilization of the GPU's video encoder, indicating its load when encoding tasks (for example, video rendering) are running.
177177

178-
W&B assigns a `gpu.{gpu_index}.encoderUtilization` tag to this metric.
178+
W&B assigns a `gpu.{gpu_index}.encoderUtilization` tag to this metric.
179179

180180
<!-- New section -->
181181
## AMD GPU

content/en/support/kb-articles/how_can_i_disable_logging_of_system_metrics_to_wb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ support:
88
- runs
99
---
1010

11-
To disable logging of [system metrics]({{< relref "/guides/models/app/settings-page/system-metrics.md" >}}), set `_disable_stats` to `True`:
11+
To disable logging of [system metrics]({{< relref "/ref/system-metrics.md" >}}), set `_disable_stats` to `True`:
1212

1313
```python
1414
wandb.init(settings=wandb.Settings(x_disable_stats=True))

content/en/support/kb-articles/how_can_i_reduce_how_frequently_to_log_system_metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ support:
88
- runs
99
---
1010

11-
To configure the frequency to log [system metrics]({{< relref "/guides/models/app/settings-page/system-metrics.md" >}}), set `_stats_sampling_interval` to a number of seconds, expressed as a float. Default: `10.0`.
11+
To configure the frequency to log [system metrics]({{< relref "/ref/system-metrics.md" >}}), set `_stats_sampling_interval` to a number of seconds, expressed as a float. Default: `10.0`.
1212

1313
```python
1414
wandb.init(settings=wandb.Settings(x_stats_sampling_interval=30.0))

content/ja/guides/integrations/lightning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ Colab のビデオチュートリアルに従うことができます。[こち
642642

643643
### 追加のコードなしでインテグレーションがログする内容は?
644644

645-
モデルのチェックポイントを W&B に保存し、今後のRunsで使用するために閲覧またはダウンロードできるようにします。また、GPU使用量やネットワークI/Oなどの[システムメトリクス]({{< relref path="/guides/models/app/settings-page/system-metrics.md" lang="ja" >}})、ハードウェア情報やOS情報などの環境情報、gitコミットやdiffパッチ、ノートブックコンテンツやセッション履歴を含む[コードの状態]({{< relref path="/guides/models/app/features/panels/code.md" lang="ja" >}})、標準出力に印刷されるものをキャプチャします。
645+
モデルのチェックポイントを W&B に保存し、今後のRunsで使用するために閲覧またはダウンロードできるようにします。また、GPU使用量やネットワークI/Oなどの[システムメトリクス](/ref/system-metrics)、ハードウェア情報やOS情報などの環境情報、gitコミットやdiffパッチ、ノートブックコンテンツやセッション履歴を含む[コードの状態]({{< relref path="/guides/models/app/features/panels/code.md" lang="ja" >}})、標準出力に印刷されるものをキャプチャします。
646646

647647
### トレーニングセットアップで `wandb.run` を使用する必要がある場合はどうすればいいですか?
648648

content/ja/support/kb-articles/how_can_i_disable_logging_of_system_metrics_to_wb.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ toc_hide: true
1010
type: docs
1111
url: /ja/support/:filename
1212
---
13-
[システムメトリクス]({{< relref path="/guides/models/app/settings-page/system-metrics.md" lang="ja" >}})のログを無効にするには、`_disable_stats``True` に設定します:
13+
[システムメトリクス](/ref/system-metrics)のログを無効にするには、`_disable_stats``True` に設定します:
1414

1515
```python
1616
wandb.init(settings=wandb.Settings(x_disable_stats=True))

content/ja/support/kb-articles/how_can_i_reduce_how_frequently_to_log_system_metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ toc_hide: true
1111
type: docs
1212
url: /ja/support/:filename
1313
---
14-
頻度を設定して[システムメトリクス]({{< relref path="/guides/models/app/settings-page/system-metrics.md" lang="ja" >}})をログするには、`_stats_sampling_interval` を秒数で設定します。これは浮動小数点として表現されます。デフォルトは `10.0` です。
14+
頻度を設定して[システムメトリクス](/ref/system-metrics)をログするには、`_stats_sampling_interval` を秒数で設定します。これは浮動小数点として表現されます。デフォルトは `10.0` です。
1515

1616
```python
1717
wandb.init(settings=wandb.Settings(x_stats_sampling_interval=30.0))

content/ko/guides/integrations/lightning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,7 @@ Colab [여기](https://wandb.me/lit-colab)에서 비디오 튜토리얼을 따
644644

645645
### 추가 코드 없이 통합 로깅은 무엇입니까?
646646

647-
모델 체크포인트를 W&B에 저장하여 볼 수 있거나 향후 run에서 사용하기 위해 다운로드할 수 있습니다. 또한 GPU 사용량 및 네트워크 I/O와 같은 [시스템 메트릭]({{< relref path="/guides/models/app/settings-page/system-metrics.md" lang="ko" >}}), 하드웨어 및 OS 정보와 같은 환경 정보, [코드 상태]({{< relref path="/guides/models/app/features/panels/code.md" lang="ko" >}}) (git 커밋 및 차이 패치, 노트북 콘텐츠 및 세션 기록 포함) 및 표준 출력에 인쇄된 모든 항목을 캡처합니다.
647+
모델 체크포인트를 W&B에 저장하여 볼 수 있거나 향후 run에서 사용하기 위해 다운로드할 수 있습니다. 또한 GPU 사용량 및 네트워크 I/O와 같은 [시스템 메트릭](/ref/system-metrics), 하드웨어 및 OS 정보와 같은 환경 정보, [코드 상태]({{< relref path="/guides/models/app/features/panels/code.md" lang="ko" >}}) (git 커밋 및 차이 패치, 노트북 콘텐츠 및 세션 기록 포함) 및 표준 출력에 인쇄된 모든 항목을 캡처합니다.
648648

649649
### 트레이닝 설정에서 `wandb.run`을 사용해야 하는 경우는 어떻게 해야 합니까?
650650

0 commit comments

Comments
 (0)