Browse Source

修改了一些介绍文档

tags/v0.4.10
ChenXin 5 years ago
parent
commit
fa246f5ab2
4 changed files with 13 additions and 5 deletions
  1. +0
    -1
      fastNLP/__init__.py
  2. +6
    -3
      fastNLP/core/callback.py
  3. +6
    -1
      fastNLP/core/const.py
  4. +1
    -0
      fastNLP/models/__init__.py

+ 0
- 1
fastNLP/__init__.py View File

@@ -33,7 +33,6 @@ __all__ = [
"EngChar2DPadder",
"AccuracyMetric",
"BMESF1PreRecMetric",
"SpanFPreRecMetric",
"SQuADMetric",


+ 6
- 3
fastNLP/core/callback.py View File

@@ -1,5 +1,10 @@
r"""
callback模块实现了 fastNLP 中的许多 callback 类,用于增强 :class:`~fastNLP.Trainer` 类,
callback模块实现了 fastNLP 中的许多 callback 类,用于增强 :class:`~fastNLP.Trainer` 类。

虽然Trainer本身已经集成了一些功能,但仍然不足以囊括训练过程中可能需要到的功能,
比如负采样,learning rate decay, Early Stop等。
为了解决这个问题fastNLP引入了callback的机制,Callback 是一种在Trainer训练过程中特定阶段会运行的函数集合。
关于Trainer的详细文档,请参见 :doc:`trainer 模块<fastNLP.core.trainer>`

我们将 :meth:`~fastNLP.Train.train` 这个函数内部分为以下的阶段,在对应阶段会触发相应的调用::

@@ -26,8 +31,6 @@ callback模块实现了 fastNLP 中的许多 callback 类,用于增强 :class:
callback.on_train_end() # 训练结束
callback.on_exception() # 这是一个特殊的步骤,在训练过程中遭遇exception会跳转到这里

关于Trainer的详细文档,请参见 :doc:`trainer 模块<fastNLP.core.trainer>`

如下面的例子所示,我们可以使用内置的 callback 类,或者继承 :class:`~fastNLP.core.callback.Callback`
定义自己的 callback 类::


+ 6
- 1
fastNLP/core/const.py View File

@@ -1,5 +1,10 @@
class Const:
"""fastNLP中field命名常量。
"""
fastNLP中field命名常量。
.. todo::
把下面这段改成表格
具体列表::

INPUT 模型的序列输入 words(复数words1, words2)


+ 1
- 0
fastNLP/models/__init__.py View File

@@ -3,6 +3,7 @@
TODO 详细介绍的表格,与主页相对应

"""
__all__ = ["CNNText", "SeqLabeling", "ESIM", "STSeqLabel", "AdvSeqLabel", "STNLICls", "STSeqCls"]
from .base_model import BaseModel
from .bert import BertForMultipleChoice, BertForQuestionAnswering, BertForSequenceClassification, \
BertForTokenClassification


Loading…
Cancel
Save