Browse Source

fix tutorial typo

tags/v0.4.10
yunfan 5 years ago
parent
commit
9f681dcd55
4 changed files with 6 additions and 6 deletions
  1. +1
    -1
      docs/source/tutorials/tutorial_1_data_preprocess.rst
  2. +2
    -2
      docs/source/tutorials/tutorial_2_load_dataset.rst
  3. +1
    -1
      docs/source/tutorials/tutorial_6_seq_labeling.rst
  4. +2
    -2
      docs/source/tutorials/tutorial_9_callback.rst

+ 1
- 1
docs/source/tutorials/tutorial_1_data_preprocess.rst View File

@@ -60,7 +60,7 @@
seq_len=3)
])

在初步构建完数据集之后,我们可以通过 `for` 循环遍历 :class:`~fastNLP.DataSet` 中的内容。
在初步构建完数据集之后,我们可以通过 `for` 循环遍历 :class:`~fastNLP.DataSet` 中的内容。

.. code-block:: python



+ 2
- 2
docs/source/tutorials/tutorial_2_load_dataset.rst View File

@@ -35,12 +35,12 @@ Part II: 数据集的使用方式

- _load 函数:从一个数据文件中读取数据到一个 :class:`~fastNLP.DataSet`
- load 函数(可以使用基类的方法):从一个或多个数据文件中读取数据到一个或多个 :class:`~fastNLP.DataSet`
- process 函数:一个或多个从数据文件中读取数据,并处理成可以训练的 :class:`~fastNLP.io.DataInfo`
- process 函数:一个或多个从数据文件中读取数据,并处理成可以训练的 :class:`~fastNLP.io.DataBundle`

**\*process函数中可以调用load函数或_load函数**

DataSetLoader的_load或者load函数返回的 :class:`~fastNLP.DataSet` 当中,内容为数据集的文本信息,process函数返回的
:class:`~fastNLP.io.DataInfo` 当中, `datasets` 的内容为已经index好的、可以直接被 :class:`~fastNLP.Trainer`
:class:`~fastNLP.io.DataBundle` 当中, `datasets` 的内容为已经index好的、可以直接被 :class:`~fastNLP.Trainer`
接受的内容。

--------------------------------------------------------


+ 1
- 1
docs/source/tutorials/tutorial_6_seq_labeling.rst View File

@@ -45,7 +45,7 @@ fastNLP可以方便地载入各种类型的数据。同时,针对常见的数

数据处理
----------------------------
我们进一步处理数据。将数据和词表封装在 :class:`~fastNLP.DataInfo` 类中。data是DataInfo的实例。
我们进一步处理数据。将数据和词表封装在 :class:`~fastNLP.DataBundle` 类中。data是DataBundle的实例。
我们输入模型的数据包括char embedding,以及word embedding。在数据处理部分,我们尝试完成词表的构建。
使用fastNLP中的Vocabulary类来构建词表。



+ 2
- 2
docs/source/tutorials/tutorial_9_callback.rst View File

@@ -44,10 +44,10 @@ Callback的构建和使用

这里,:class:`~fastNLP.Callback` 中所有以 ``on_`` 开头的类方法会在 :class:`~fastNLP.Trainer` 的训练中在特定时间调用。
如 on_train_begin() 会在训练开始时被调用,on_epoch_end() 会在每个 epoch 结束时调用。
具体有哪些类方法,参见文档。
具体有哪些类方法,参见文档 :class:`~fastNLP.Callback`

另外,为了使用方便,可以在 :class:`~fastNLP.Callback` 内部访问 :class:`~fastNLP.Trainer` 中的属性,如 optimizer, epoch, step,分别对应训练时的优化器,当前epoch数,和当前的总step数。
具体可访问的属性,参见文档。
具体可访问的属性,参见文档 :class:`~fastNLP.Callback`

使用Callback
在定义好 :class:`~fastNLP.Callback` 之后,就能将它传入Trainer的 ``callbacks`` 参数,在实际训练时使用。


Loading…
Cancel
Save