Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Update Config File to Added WandBLogger Hook Details #1606

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[Docs] Update Config File to Added WandBLogger Hook Details #1606

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
db2da8f
[Docs] Update Config File to Added WandBLogger Hook Details
Nourollah Aug 29, 2022
aa6f29f
[Docs] lint test passed
Nourollah Sep 2, 2022
a410dbd
[Docs] Removed redundant text
Nourollah Sep 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/en/tutorials/0_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,17 @@ configs/{topic}/{task}/{algorithm}/{dataset}/{backbone}_[model_setting]_{dataset
step=[170, 200]) # Steps to decay the learning rate
total_epochs = 210 # Total epochs to train the model
log_config = dict( # Config to register logger hook
interval=50, # Interval to print the log
intervlog_config = dict( # Config to register logger hook
interval=50, # Interval to print the log
hooks=[
dict(type='TextLoggerHook', by_epoch=False), # The logger used to record the training process
dict(type='TensorboardLoggerHook', by_epoch=False), # The Tensorboard logger to record log offline
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why by_epoch is set to False by default?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used this parameter to show the possibility of changing it to True or False to those who want to use it. It is possible to give it the True default value, I don't have any special reason to use the False value as default.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's better not to change the default setting here. To show the options, we can add by_epoch=True here.

dict(type='WandbLoggerHook', by_epoch=False, # The Wandb logger is also supported, It requires `wandb` to be installed.
init_kwargs={'entity': "OpenMMLab", # The entity used to log on Wandb
'project': "MMPose", # Project name in WandB
'config': cfg_dict}), # Check https://docs.wandb.ai/ref/python/init for more init arguments.
]) # ClearMLLoggerHook, DvcliveLoggerHook, MlflowLoggerHook, NeptuneLoggerHook, PaviLoggerHook, SegmindLoggerHook are also supported based on MMCV implementation.
al=50, # Interval to print the log
jin-s13 marked this conversation as resolved.
Show resolved Hide resolved
hooks=[
dict(type='TextLoggerHook'), # The logger used to record the training process
# dict(type='TensorboardLoggerHook') # The Tensorboard logger is also supported
Expand Down
17 changes: 11 additions & 6 deletions docs/zh_cn/tutorials/0_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,17 @@ configs/{topic}/{task}/{algorithm}/{dataset}/{backbone}_[model_setting]_{dataset
warmup_ratio=0.001, # 预热开始时使用的学习率，等于预热比 (warmup_ratio) * 初始学习率
step=[170, 200]) # 降低学习率的步数　
total_epochs = 210 # 训练模型的总轮数
log_config = dict( # 注册日志记录器钩子的配置
interval=50, # 打印日志的间隔
hooks=[
dict(type='TextLoggerHook'), # 用来记录训练过程的日志记录器
# dict(type='TensorboardLoggerHook') # 也支持 Tensorboard 日志记录器
])
log_config = dict( # 注册日志钩子的设置
interval=20, # 打印日志间隔
hooks=[ # 训练期间执行的钩子
dict(type='TextLoggerHook', by_epoch=False),
dict(type='TensorboardLoggerHook', by_epoch=False),
dict(type='WandbLoggerHook', by_epoch=False, # 还支持 Wandb 记录器，它需要安装 `wandb`。
init_kwargs={'entity': "entity", # 用于登录wandb的实体
'project': "project", # WandB中的项目名称
'config': cfg_dict}), # 检查 https://docs.wandb.ai/ref/python/init 以获取更多初始化参数
])


channel_cfg = dict(
num_output_channels=17, # 关键点头部的输出通道数
Expand Down