Browse Source

大幅更新文档:

1. 删除了aggregator相关的文档
2. 将 fitlog 教程移到详细教程的子目录
tags/v0.4.10
ChenXin 5 years ago
parent
commit
ee1e470e71
11 changed files with 23 additions and 39 deletions
  1. +0
    -7
      docs/source/fastNLP.modules.aggregator.attention.rst
  2. +0
    -7
      docs/source/fastNLP.modules.aggregator.pooling.rst
  3. +0
    -17
      docs/source/fastNLP.modules.aggregator.rst
  4. +0
    -1
      docs/source/fastNLP.modules.rst
  5. +0
    -1
      docs/source/index.rst
  6. +3
    -3
      docs/source/tutorials/tutorial_10_fitlog.rst
  7. +3
    -0
      docs/source/tutorials/tutorial_1_data_preprocess.rst
  8. +1
    -1
      docs/source/tutorials/tutorial_9_callback.rst
  9. +14
    -1
      docs/source/user/example.rst
  10. +1
    -0
      docs/source/user/tutorials.rst
  11. +1
    -1
      fastNLP/core/callback.py

+ 0
- 7
docs/source/fastNLP.modules.aggregator.attention.rst View File

@@ -1,7 +0,0 @@
fastNLP.modules.aggregator.attention
====================================

.. automodule:: fastNLP.modules.aggregator.attention
:members:
:undoc-members:
:show-inheritance:

+ 0
- 7
docs/source/fastNLP.modules.aggregator.pooling.rst View File

@@ -1,7 +0,0 @@
fastNLP.modules.aggregator.pooling
==================================

.. automodule:: fastNLP.modules.aggregator.pooling
:members:
:undoc-members:
:show-inheritance:

+ 0
- 17
docs/source/fastNLP.modules.aggregator.rst View File

@@ -1,17 +0,0 @@
fastNLP.modules.aggregator
==========================

.. automodule:: fastNLP.modules.aggregator
:members:
:undoc-members:
:show-inheritance:

子模块
----------

.. toctree::
:titlesonly:

fastNLP.modules.aggregator.attention
fastNLP.modules.aggregator.pooling


+ 0
- 1
docs/source/fastNLP.modules.rst View File

@@ -12,6 +12,5 @@ fastNLP.modules
.. toctree::
:titlesonly:

fastNLP.modules.aggregator
fastNLP.modules.decoder
fastNLP.modules.encoder

+ 0
- 1
docs/source/index.rst View File

@@ -55,7 +55,6 @@ fastNLP 在 :mod:`~fastNLP.models` 模块中内置了如 :class:`~fastNLP.models
安装指南 </user/installation>
快速入门 </user/quickstart>
详细指南 </user/tutorials>
科研指南 </user/with_fitlog>

API 文档
-------------


docs/source/user/with_fitlog.rst → docs/source/tutorials/tutorial_10_fitlog.rst View File

@@ -1,6 +1,6 @@
=================
科研向导
=================
============================================
使用fitlog 辅助 fastNLP 进行科研
============================================

本文介绍结合使用 fastNLP 和 fitlog 进行科研的方法。


+ 3
- 0
docs/source/tutorials/tutorial_1_data_preprocess.rst View File

@@ -122,6 +122,9 @@ FastNLP 同样提供了多种删除数据的方法 :func:`~fastNLP.DataSet.drop`
return words
dataset.apply(get_words, new_field_name='words')

除了手动处理数据集之外,你还可以使用 fastNLP 提供的各种 :class:`~fastNLP.io.base_loader.DataSetLoader` 来进行数据处理。
详细请参考这篇教程 :doc:`使用DataSetLoader加载数据集 </tutorials/tutorial_2_load_dataset>` 。

-----------------------------
DataSet与pad
-----------------------------


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

@@ -1,4 +1,3 @@

==============================================================================
Callback 教程
==============================================================================
@@ -54,6 +53,7 @@ Callback的构建和使用
在定义好 :class:`~fastNLP.Callback` 之后,就能将它传入Trainer的 ``callbacks`` 参数,在实际训练时使用。

.. code-block:: python

"""
数据预处理,模型定义等等
"""


+ 14
- 1
docs/source/user/example.rst View File

@@ -124,6 +124,19 @@ False False False
True True True
===== ===== ======

csv 表格
============

.. csv-table::
:header: sentence, target

This is the first instance ., 0
Second instance ., 1
Third instance ., 1
..., ...



[重要]各种链接
===================

@@ -131,7 +144,7 @@ True True True

\<\>内表示的是链接地址,\<\>外的是显示到外面的文字

:doc:`根据文件名链接 </user/with_fitlog>`
:doc:`根据文件名链接 </user/quickstart>`

:mod:`~fastNLP.core.batch`



+ 1
- 0
docs/source/user/tutorials.rst View File

@@ -14,4 +14,5 @@ fastNLP详细使用教程
7. 使用Modules和Models快速搭建自定义模型 </tutorials/tutorial_7_modules_models>
8. 使用Metric快速评测你的模型 </tutorials/tutorial_8_metrics>
9. 使用Callback自定义你的训练过程 </tutorials/tutorial_9_callback>
10. 使用fitlog 辅助 fastNLP 进行科研 </tutorials/tutorial_10_fitlog>


+ 1
- 1
fastNLP/core/callback.py View File

@@ -674,7 +674,7 @@ class TensorboardCallback(Callback):
.. warning::
fastNLP 已停止对此功能的维护,请等待 fastNLP 兼容 PyTorch1.1 的下一个版本。
或者使用和 fastNLP 高度配合的 fitlog(参见 :doc:`/user/with_fitlog` )。
或者使用和 fastNLP 高度配合的 fitlog(参见 :doc:`/tutorials/tutorial_10_fitlog` )。
"""


Loading…
Cancel
Save