From a5c63643f4dc6d5f94da2d835368c14cdfc51f5f Mon Sep 17 00:00:00 2001 From: Yige Xu Date: Fri, 11 Oct 2019 16:15:36 +0800 Subject: [PATCH 1/2] Update README.md --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 017ebdfb..f1d17144 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,6 @@ pip install fastNLP python -m spacy download en ``` -目前使用pypi安装fastNLP的版本是0.4.1，有较多功能仍未更新，最新内容以master分支为准。 -fastNLP0.5.0版本将在近期推出，请密切关注。 - ## fastNLP教程 @@ -60,12 +57,11 @@ fastNLP0.5.0版本将在近期推出，请密切关注。 - [8. 使用Modules和Models快速搭建自定义模型](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_8_modules_models.html) - [9. 快速实现序列标注模型](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_9_seq_labeling.html) - [10. 使用Callback自定义你的训练过程](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_10_callback.html) -- [11. 使用fitlog 辅助 fastNLP 进行科研](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_11_fitlog.html) ### 扩展教程 - [Extend-1. BertEmbedding的各种用法](https://fastnlp.readthedocs.io/zh/latest/tutorials/extend_1_bert_embedding.html) - +- [Extend-2. 使用fitlog 辅助 fastNLP 进行科研](https://fastnlp.readthedocs.io/zh/latest/tutorials/extend_2_fitlog.html) ## 内置组件 @@ -91,19 +87,19 @@ fastNLP 在 embeddings 模块中内置了几种不同的embedding：静态embedd encoder 将输入编码为具有具有表示能力的向量 - embedding, RNN, CNN, transformer + Embedding, RNN, CNN, Transformer, ... decoder 将具有某种表示意义的向量解码为需要的输出形式 - MLP, CRF + MLP, CRF, ... ## 项目结构 - +![](./docs/source/figures/workflow.png) fastNLP的大致工作流程如上图所示，而项目结构如下： @@ -130,7 +126,7 @@ fastNLP的大致工作流程如上图所示，而项目结构如下： fastNLP.io - 实现了读写功能，包括数据读入与预处理，模型读写，自动下载等 + 实现了读写功能，包括数据读入与预处理，模型读写，数据与模型自动下载等 From 33b995758a636bbcb6143f9368b8a600312e229f Mon Sep 17 00:00:00 2001 From: Yige Xu Date: Fri, 11 Oct 2019 16:16:05 +0800 Subject: [PATCH 2/2] update documents --- .../tutorials/{tutorial_11_fitlog.rst => extend_2_fitlog.rst} | 0 docs/source/user/installation.rst | 3 ++- docs/source/user/tutorials.rst | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) rename docs/source/tutorials/{tutorial_11_fitlog.rst => extend_2_fitlog.rst} (100%) diff --git a/docs/source/tutorials/tutorial_11_fitlog.rst b/docs/source/tutorials/extend_2_fitlog.rst similarity index 100% rename from docs/source/tutorials/tutorial_11_fitlog.rst rename to docs/source/tutorials/extend_2_fitlog.rst diff --git a/docs/source/user/installation.rst b/docs/source/user/installation.rst index 42ea402c..b4156f6a 100644 --- a/docs/source/user/installation.rst +++ b/docs/source/user/installation.rst @@ -13,8 +13,9 @@ fastNLP 依赖如下包:: nltk>=3.4.1 requests spacy + prettytable>=0.7.2 -其中torch的安装可能与操作系统及 CUDA 的版本相关，请参见 `PyTorch 官网 `_ 。 +其中torch的安装可能与操作系统及 CUDA 的版本相关，请参见 `PyTorch 官网 `_ 。 在依赖包安装完成的情况，您可以在命令行执行如下指令完成安装 .. code:: shell diff --git a/docs/source/user/tutorials.rst b/docs/source/user/tutorials.rst index 2733ceb5..6d239e32 100644 --- a/docs/source/user/tutorials.rst +++ b/docs/source/user/tutorials.rst @@ -17,9 +17,9 @@ fastNLP 详细使用教程 使用Modules和Models快速搭建自定义模型 快速实现序列标注模型 使用Callback自定义你的训练过程 - 使用fitlog 辅助 fastNLP 进行科研 .. toctree:: :maxdepth: 1 - 拓展阅读：BertEmbedding的各种用法 + 拓展阅读1：BertEmbedding的各种用法 + 拓展阅读2：使用fitlog 辅助 fastNLP 进行科研