From b161aa6c937cf7292a8145771e07064246930438 Mon Sep 17 00:00:00 2001
From: MorningForest <2297662686@qq.com>
Date: Mon, 11 Apr 2022 18:50:36 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0README.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 138 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 138 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..74090646
--- /dev/null
+++ b/README.md
@@ -0,0 +1,138 @@
+# fastNLP
+
+[![Build Status](https://travis-ci.org/fastnlp/fastNLP.svg?branch=master)](https://travis-ci.org/fastnlp/fastNLP)
+[![codecov](https://codecov.io/gh/fastnlp/fastNLP/branch/master/graph/badge.svg)](https://codecov.io/gh/fastnlp/fastNLP)
+[![Pypi](https://img.shields.io/pypi/v/fastNLP.svg)](https://pypi.org/project/fastNLP)
+![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)
+[![Documentation Status](https://readthedocs.org/projects/fastnlp/badge/?version=latest)](http://fastnlp.readthedocs.io/?badge=latest)
+
+fastNLP是一款轻量级的自然语言处理（NLP）工具包，目标是快速实现NLP任务以及构建复杂模型。
+
+fastNLP具有如下的特性：
+
+- 统一的Tabular式数据容器，简化数据预处理过程；
+- 内置多种数据集的Loader和Pipe，省去预处理代码;
+- 各种方便的NLP工具，例如Embedding加载（包括ELMo和BERT）、中间数据cache等;
+- 部分[数据集与预训练模型](https://docs.qq.com/sheet/DVnpkTnF6VW9UeXdh?c=A1A0A0)的自动下载；
+- 提供多种神经网络组件以及复现模型（涵盖中文分词、命名实体识别、句法分析、文本分类、文本匹配、指代消解、摘要等任务）;
+- Trainer提供多种内置Callback函数，方便实验记录、异常捕获等。
+
+## 安装指南
+
+fastNLP 依赖以下包:
+
++ numpy>=1.14.2
++ torch>=1.0.0
++ tqdm>=4.28.1
++ nltk>=3.4.1
++ requests
++ spacy
++ prettytable>=0.7.2
+
+其中torch的安装可能与操作系统及 CUDA 的版本相关，请参见 [PyTorch 官网](https://pytorch.org/) 。 
+在依赖包安装完成后，您可以在命令行执行如下指令完成安装
+
+```shell
+pip install fastNLP
+python -m spacy download en
+```
+
+
+## fastNLP教程
+中文[文档](https://fastnlp.readthedocs.io/)、[教程](https://fastnlp.readthedocs.io/zh/latest/user/tutorials.html)
+
+### 快速入门
+
+- [0. 快速入门](https://fastnlp.readthedocs.io/zh/latest/user/quickstart.html)
+
+### 详细使用教程
+
+- [1. 使用DataSet预处理文本](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_1_data_preprocess.html)
+- [2. 使用Vocabulary转换文本与index](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_2_vocabulary.html)
+- [3. 使用Embedding模块将文本转成向量](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_3_embedding.html)
+- [4. 使用Loader和Pipe加载并处理数据集](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_4_load_dataset.html)
+- [5. 动手实现一个文本分类器I-使用Trainer和Tester快速训练和测试](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_5_loss_optimizer.html)
+- [6. 动手实现一个文本分类器II-使用DataSetIter实现自定义训练过程](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_6_datasetiter.html)
+- [7. 使用Metric快速评测你的模型](https://fastnlp.readthedocs.io/zh/latest/tutorials/tutorial_7_metrics.html)
+- [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)
+
+### 扩展教程
+
+- [Extend-1. BertEmbedding的各种用法](https://fastnlp.readthedocs.io/zh/latest/tutorials/extend_1_bert_embedding.html)
+- [Extend-2. 分布式训练简介](https://fastnlp.readthedocs.io/zh/latest/tutorials/extend_2_dist.html)
+- [Extend-3. 使用fitlog 辅助 fastNLP 进行科研](https://fastnlp.readthedocs.io/zh/latest/tutorials/extend_3_fitlog.html)
+
+
+## 内置组件
+
+大部分用于的 NLP 任务神经网络都可以看做由词嵌入（embeddings）和两种模块：编码器（encoder）、解码器（decoder）组成。
+
+以文本分类任务为例，下图展示了一个BiLSTM+Attention实现文本分类器的模型流程图：
+
+
+![](./docs/source/figures/text_classification.png)
+
+fastNLP 在 embeddings 模块中内置了几种不同的embedding：静态embedding（GloVe、word2vec）、上下文相关embedding
+（ELMo、BERT）、字符embedding（基于CNN或者LSTM的CharEmbedding）
+
+与此同时，fastNLP 在 modules 模块中内置了两种模块的诸多组件，可以帮助用户快速搭建自己所需的网络。 两种模块的功能和常见组件如下:
+
+<table>
+<tr>
+    <td><b> 类型 </b></td>
+    <td><b> 功能 </b></td>
+    <td><b> 例子 </b></td>
+</tr>
+<tr>
+    <td> encoder </td>
+    <td> 将输入编码为具有具有表示能力的向量 </td>
+    <td> Embedding, RNN, CNN, Transformer, ...
+</tr>
+<tr>
+    <td> decoder </td>
+    <td> 将具有某种表示意义的向量解码为需要的输出形式 </td>
+    <td> MLP, CRF, ... </td>
+</tr>
+</table>
+
+
+## 项目结构
+
+<div align=center><img width="450" height="350" src="./docs/source/figures/workflow.png"/></div>
+
+
+
+fastNLP的大致工作流程如上图所示，而项目结构如下：
+
+<table>
+<tr>
+    <td><b> fastNLP </b></td>
+    <td> 开源的自然语言处理库 </td>
+</tr>
+<tr>
+    <td><b> fastNLP.core </b></td>
+    <td> 实现了核心功能，包括数据处理组件、训练器、测试器等 </td>
+</tr>
+<tr>
+    <td><b> fastNLP.models </b></td>
+    <td> 实现了一些完整的神经网络模型 </td>
+</tr>
+<tr>
+    <td><b> fastNLP.modules </b></td>
+    <td> 实现了用于搭建神经网络模型的诸多组件 </td>
+</tr>
+<tr>
+    <td><b> fastNLP.embeddings </b></td>
+    <td> 实现了将序列index转为向量序列的功能，包括读取预训练embedding等 </td>
+</tr>
+<tr>
+    <td><b> fastNLP.io </b></td>
+    <td> 实现了读写功能，包括数据读入与预处理，模型读写，数据与模型自动下载等 </td>
+</tr>
+</table>
+
+<hr>
+
+*In memory of @FengZiYjun.  May his soul rest in peace. We will miss you very very much!*