Skip to content

Commit 03ad86c

Browse files
authored
[Docs] Add a image for neptune (#1312)
1 parent 43e308c commit 03ad86c

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

docs/en/common_usage/visualize_training_log.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Below, we'll show you how to configure an experiment management tool in just one
66

77
## TensorBoard
88

9-
Configure the `visualizer` in the initialization parameters of the Runner, and set `vis_backends` to `TensorboardVisBackend`.
9+
Configure the `visualizer` in the initialization parameters of the Runner, and set `vis_backends` to [TensorboardVisBackend](mmengine.visualization.TensorboardVisBackend).
1010

1111
```python
1212
runner = Runner(
@@ -32,7 +32,7 @@ pip install wandb
3232
wandb login
3333
```
3434

35-
Configure the `visualizer` in the initialization parameters of the Runner, and set `vis_backends` to `WandbVisBackend`.
35+
Configure the `visualizer` in the initialization parameters of the Runner, and set `vis_backends` to [WandbVisBackend](mmengine.visualization.WandbVisBackend).
3636

3737
```python
3838
runner = Runner(
@@ -81,7 +81,7 @@ pip install clearml
8181
clearml-init
8282
```
8383

84-
Configure the `visualizer` in the initialization parameters of the Runner, and set `vis_backends` to `ClearMLVisBackend`.
84+
Configure the `visualizer` in the initialization parameters of the Runner, and set `vis_backends` to [ClearMLVisBackend](mmengine.visualization.ClearMLVisBackend).
8585

8686
```python
8787
runner = Runner(
@@ -108,7 +108,7 @@ Before using Neptune, you need to install `neptune` dependency library and refer
108108
pip install neptune
109109
```
110110

111-
Configure the `Runner` in the initialization parameters of the Runner, and set `vis_backends` to `NeptuneVisBackend`.
111+
Configure the `Runner` in the initialization parameters of the Runner, and set `vis_backends` to [NeptuneVisBackend](mmengine.visualization.NeptuneVisBackend).
112112

113113
```python
114114
runner = Runner(
@@ -125,6 +125,8 @@ runner = Runner(
125125
runner.train()
126126
```
127127

128+
![image](https://github.com/open-mmlab/mmengine/assets/58739961/9122e2ac-cc4f-43b2-bad3-ae33faa64043)
129+
128130
Please note: If the `project` and `api_token` are not specified, neptune will be set to offline mode and the generated files will be saved to the local `.neptune` file.
129131
It is recommended to specify the `project` and `api_token` during initialization as shown below.
130132

docs/zh_cn/common_usage/visualize_training_log.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# 可视化训练日志
22

3-
MMEngine 集成了 [TensorBoard](https://www.tensorflow.org/tensorboard?hl=zh-cn)[Weights & Biases (WandB)](https://docs.wandb.ai/)[MLflow](https://mlflow.org/docs/latest/index.html) [ClearML](https://clear.ml/docs/latest/docs)[Neptune](https://docs.neptune.ai/)实验管理工具,你可以很方便地跟踪和可视化损失及准确率等指标。
3+
MMEngine 集成了 [TensorBoard](https://www.tensorflow.org/tensorboard?hl=zh-cn)[Weights & Biases (WandB)](https://docs.wandb.ai/)[MLflow](https://mlflow.org/docs/latest/index.html)[ClearML](https://clear.ml/docs/latest/docs)[Neptune](https://docs.neptune.ai/) 实验管理工具,你可以很方便地跟踪和可视化损失及准确率等指标。
44

55
下面基于[15 分钟上手 MMENGINE](../get_started/15_minutes.md)中的例子介绍如何一行配置实验管理工具。
66

77
## TensorBoard
88

9-
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 `TensorboardVisBackend`
9+
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 [TensorboardVisBackend](mmengine.visualization.TensorboardVisBackend)
1010

1111
```python
1212
runner = Runner(
@@ -32,7 +32,7 @@ pip install wandb
3232
wandb login
3333
```
3434

35-
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 `WandbVisBackend`
35+
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 [WandbVisBackend](mmengine.visualization.WandbVisBackend)
3636

3737
```python
3838
runner = Runner(
@@ -81,7 +81,7 @@ pip install clearml
8181
clearml-init
8282
```
8383

84-
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 `ClearMLVisBackend`
84+
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 [ClearMLVisBackend](mmengine.visualization.ClearMLVisBackend)
8585

8686
```python
8787
runner = Runner(
@@ -108,7 +108,7 @@ runner.train()
108108
pip install neptune
109109
```
110110

111-
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 `NeptuneVisBackend`
111+
设置 `Runner` 初始化参数中的 `visualizer`,并将 `vis_backends` 设置为 [NeptuneVisBackend](mmengine.visualization.NeptuneVisBackend)
112112

113113
```python
114114
runner = Runner(
@@ -125,7 +125,9 @@ runner = Runner(
125125
runner.train()
126126
```
127127

128-
请注意:若未提供 `project``api_token` ,neptune 将被设置成离线模式,产生的文件将保存到本地`.neptune`文件下。
128+
![image](https://github.com/open-mmlab/mmengine/assets/58739961/9122e2ac-cc4f-43b2-bad3-ae33faa64043)
129+
130+
请注意:若未提供 `project``api_token` ,neptune 将被设置成离线模式,产生的文件将保存到本地 `.neptune` 文件下。
129131
推荐在初始化时提供 `project``api_token` ,具体方法如下所示:
130132

131133
```python

mmengine/visualization/vis_backend.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,9 @@ class NeptuneVisBackend(BaseVisBackend):
10051005
>>> cfg = Config(dict(a=1, b=dict(b1=[0, 1])))
10061006
>>> neptune_vis_backend.add_config(cfg)
10071007
1008+
Note:
1009+
`New in version 0.8.5.`
1010+
10081011
Args:
10091012
save_dir (str, optional): The root directory to save the files
10101013
produced by the visualizer. NeptuneVisBackend does
@@ -1016,7 +1019,7 @@ class NeptuneVisBackend(BaseVisBackend):
10161019
`namespace/project_name`. If `project` is not specified,
10171020
the value of `NEPTUNE_PROJECT` environment variable
10181021
will be taken.
1019-
- api_token (str): Users API token. If api_token is not api_token,
1022+
- api_token (str): User's API token. If api_token is not api_token,
10201023
the value of `NEPTUNE_API_TOKEN` environment variable will
10211024
be taken. Note: It is strongly recommended to use
10221025
`NEPTUNE_API_TOKEN` environment variable rather than

0 commit comments

Comments
 (0)