Browse Source

修改了一些文档问题

tags/v0.4.10
ChenXin 6 years ago
parent
commit
7325f78dfb
2 changed files with 9 additions and 7 deletions
  1. +5
    -4
      fastNLP/core/callback.py
  2. +4
    -3
      fastNLP/core/trainer.py

+ 5
- 4
fastNLP/core/callback.py View File

@@ -370,16 +370,17 @@ class GradientClipCallback(Callback):

每次backward前,将parameter的gradient clip到某个范围。

:param None,torch.Tensor,List[torch.Tensor] parameters: 一般通过model.parameters()获得。如果为None则默认对Trainer
的model中所有参数进行clip
:param None,torch.Tensor,List[torch.Tensor] parameters: 一般通过model.parameters()获得。
如果为None则默认对Trainer的model中所有参数进行clip
:param float clip_value: 将gradient 限制到[-clip_value, clip_value]。clip_value应该为正数
:param str clip_type: 支持'norm', 'value'
两种::

1 'norm', 将gradient的norm rescale到[-clip_value, clip_value]
2 'value', 将gradient限制在[-clip_value, clip_value], 小于-clip_value的gradient被赋值为-clip_value;
大于clip_value的gradient被赋值为clip_value.
2 'value', 将gradient限制在[-clip_value, clip_value],
小于-clip_value的gradient被赋值为-clip_value;
大于clip_value的gradient被赋值为clip_value.

"""


+ 4
- 3
fastNLP/core/trainer.py View File

@@ -498,14 +498,15 @@ class Trainer(object):
"""
使用该函数使Trainer开始训练。

:param bool load_best_model: 该参数只有在初始化提供了dev_data的情况下有效,如果True, trainer将在返回之前重新加载dev表现
最好的模型参数。
:param bool load_best_model: 该参数只有在初始化提供了dev_data的情况下有效,
如果True, trainer将在返回之前重新加载dev表现最好的模型参数。
:return dict: 返回一个字典类型的数据,
内含以下内容::

seconds: float, 表示训练时长
以下三个内容只有在提供了dev_data的情况下会有。
best_eval: Dict of Dict, 表示evaluation的结果。第一层的key为Metric的名称,第二层的key为具体的Metric
best_eval: Dict of Dict, 表示evaluation的结果。第一层的key为Metric的名称,
第二层的key为具体的Metric
best_epoch: int,在第几个epoch取得的最佳值
best_step: int, 在第几个step(batch)更新取得的最佳值



Loading…
Cancel
Save