Browse Source

修复一点tutorial的typo

tags/v0.5.5
yh_cc 4 years ago
parent
commit
9e9c6c1aa2
2 changed files with 12 additions and 11 deletions
  1. +8
    -9
      docs/source/tutorials/tutorial_1_data_preprocess.rst
  2. +4
    -2
      docs/source/tutorials/tutorial_2_vocabulary.rst

+ 8
- 9
docs/source/tutorials/tutorial_1_data_preprocess.rst View File

@@ -19,7 +19,7 @@ fastNLP中的DataSet
DataSet的构建
-----------------------------

我们使用传入字典的方式构建一个数据集,这是 :class:`~fastNLP.DataSet` 初始化的最基础的方式
我们使用传入字典的方式初始化一个DataSet,这是 :class:`~fastNLP.DataSet` 初始化的最基础的方式

.. code-block:: python

@@ -42,7 +42,7 @@ DataSet的构建
+------------------------------+------------------------------------------------+---------+


我们还可以使用 :func:`~fastNLP.DataSet.append` 方法向数据集内增加数据
我们还可以使用 :func:`~fastNLP.DataSet.append` 方法向DataSet增加数据

.. code-block:: python

@@ -55,7 +55,7 @@ DataSet的构建
dataset.append(instance)
# 可以继续append更多内容,但是append的instance应该和前面的instance拥有完全相同的field

另外,我们还可以用 :class:`~fastNLP.Instance` 数组的方式构建数据集
另外,我们还可以用 :class:`~fastNLP.Instance` 数组的方式构建DataSet

.. code-block:: python

@@ -70,7 +70,7 @@ DataSet的构建
seq_len=3)
])

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

.. code-block:: python

@@ -81,14 +81,14 @@ DataSet的删除
-----------------------------

FastNLP 同样提供了多种删除数据的方法 :func:`~fastNLP.DataSet.drop` 、 :func:`~fastNLP.DataSet.delete_instance` 和 :func:`~fastNLP.DataSet.delete_field`
我们先用下面的代码生成一个只有两列的样例数据集,第一列的值分别为 -5 ~ 4,第二列的值均为 0.
我们先用下面的代码生成一个只有两列的样例DataSet,第一列的值分别为 -5 ~ 4,第二列的值均为 0.

.. code-block:: python

from fastNLP import DataSet
dataset = DataSet({'a': range(-5, 5), 'c': [0]*10})

然后我们使用三种方法进行删除,删除后的数据集仅包含名为 c 的一列,包含4个值为0 的数据。
然后我们使用三种方法进行删除,删除后的DataSet仅包含名为 c 的一列,包含4个值为0 的数据。

.. code-block:: python

@@ -118,9 +118,8 @@ FastNLP 同样提供了多种删除数据的方法 :func:`~fastNLP.DataSet.drop`
len(dataset)

其次,我们可以使用 :func:`~fastNLP.DataSet.apply` 或 :func:`~fastNLP.DataSet.apply_field` 进行数据预处理操作操作。
这两个方法通过传入一个对单一 :mod:`~fastNLP.core.instance` 操作的函数,
自动地帮助你对一个 :mod:`~fastNLP.core.field` 中的每个 :mod:`~fastNLP.core.instance` 调用这个函数,完成整体的操作。
这个传入的函数可以是 lambda 匿名函数,也可以是完整定义的函数。同时,你还可以用 ``new_field_name`` 参数指定数据处理后存储的 :mod:`~fastNLP.core.field` 的名称。
使用以上的两个方法需要传入一个函数,函数可以是 lambda 匿名函数,也可以是完整定义的函数,fastNLP将对DataSet遍历地应用该函数。
同时,你还可以用 ``new_field_name`` 参数指定函数返回值组成的新 :mod:`~fastNLP.core.field` 的名称。

.. code-block:: python



+ 4
- 2
docs/source/tutorials/tutorial_2_vocabulary.rst View File

@@ -24,7 +24,7 @@ fastNLP中的Vocabulary
vocab.to_index('positive') # 输出0
vocab.to_index('neutral') # 会报错,因为没有unk这种情况

除了通过以上的方式建立词表,Vocabulary还可以通过使用下面的函数直从 :class:`~fastNLP.DataSet` 中的某一列建立词表以及将该列转换为index
除了通过以上的方式建立词表,Vocabulary还可以通过使用下面的函数直从 :class:`~fastNLP.DataSet` 中的某一列建立词表以及将该列转换为index

.. code-block:: python

@@ -39,7 +39,9 @@ fastNLP中的Vocabulary
})

vocab = Vocabulary()
# 从该dataset中的chars列建立词表
vocab.from_dataset(dataset, field_name='chars')
# 使用vocabulary将chars列转换为index
vocab.index_dataset(dataset, field_name='chars')

target_vocab = Vocabulary(padding=None, unknown=None)
@@ -60,7 +62,7 @@ fastNLP中的Vocabulary
一些使用tips
-----------------------------

通过使用from_dataset()函数在DataSet上建立词表时,将测试集和验证集放入参数no_create_entry_dataset中,如下所示
在使用from_dataset()函数建立词表时,将测试集和验证集放入参数no_create_entry_dataset中,如下所示

.. code-block:: python



Loading…
Cancel
Save