Skip to content

Commit

Permalink
Update docs and readme (PaddlePaddle#523)
Browse files Browse the repository at this point in the history
* update readme for live class

* Update README

* update readme

* update readme

Co-authored-by: yingyibiao <[email protected]>
  • Loading branch information
ZeyuChen and yingyibiao authored Jun 8, 2021
1 parent a312e76 commit f883e61
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ PaddleNLP 2.0是飞桨生态的文本领域核心库,具备**易用的文本
### pip安装

```
pip install --upgrade paddlenlp -i https://pypi.org/simple
pip install --upgrade paddlenlp
```

更多关于PaddlePaddle和PaddleNLP安装的详细教程请查看[Installation](./docs/get_started/installation.rst)
Expand All @@ -53,7 +53,7 @@ pip install --upgrade paddlenlp -i https://pypi.org/simple

### Transformer API: 强大的预训练模型生态底座

覆盖**15**个网络结构和**67**个预训练模型参数,既包括百度自研的预训练模型如ERNIE系列, PLATO, SKEP等,也涵盖业界主流的中文预训练模型。
覆盖**15**个网络结构和**67**个预训练模型参数,既包括百度自研的预训练模型如ERNIE系列, PLATO, SKEP等,也涵盖业界主流的中文预训练模型。也欢迎开发者进预训练模贡献!🤗

```python
from paddlenlp.transformers import *
Expand All @@ -76,10 +76,10 @@ from paddlenlp.transformers import ErnieTokenizer, ErnieModel
tokenizer = ErnieTokenizer.from_pretrained('ernie-1.0')
text = tokenizer('自然语言处理')

# 获取语义表示
# 语义表示
model = ErnieModel.from_pretrained('ernie-1.0')
pooled_output, sequence_output = model(input_ids=paddle.to_tensor([text['input_ids']]))
# 文本分类/句对匹配
# 文本分类 & 句对匹配
model = ErnieForSequenceClassifiation.from_pretrained('ernie-1.0')
# 序列标注
model = ErnieForTokenClassifiation.from_pretrained('ernie-1.0')
Expand Down Expand Up @@ -115,7 +115,7 @@ wordemb.cosine_sim("艺术", "火车")
>>> 0.14792643
```

内置50+中文词向量,覆盖多种领域语料、如百科、新闻、微博等。更多使用方法请参考[Embedding文档](./examples/word_embedding/README.md)
内置50+中文词向量,覆盖多种领域语料、如百科、新闻、微博等。更多使用方法请参考[Embedding文档](./docs/model_zoo/embeddings.md)

### 更多API使用文档

Expand Down
17 changes: 8 additions & 9 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,19 @@ English | [简体中文](./README.md)
* python >= 3.6
* paddlepaddle >= 2.1

More information about PaddlePaddle installation please refer to [PaddlePaddle's Website](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/conda/linux-conda.html)
More information about PaddlePaddle installation please refer to [PaddlePaddle's Website](https://www.paddlepaddle.org.cn/install/quick?docurl=/documentation/docs/zh/install/conda/linux-conda.html).

### PIP Installation

```
pip install --upgrade paddlenlp -i https://pypi.org/simple
pip install --upgrade paddlenlp
```

## Easy-to-use API


### Transformer API: Awesome Pre-trained Model Ecosystem

We provide **15** network architecture and **67** pretrained models. Not only includes all the SOTA model like ERNIE, PLATO and SKEP released by Baidu, but also integrates most of high quality Chinese pretrained model developed by other organizations. We also welcome developer to contribute your transformer model! 🤗
We provide **15** network architectures and **67** pretrained models. Not only includes all the SOTA model like ERNIE, PLATO and SKEP released by Baidu, but also integrates most of the high quality Chinese pretrained model developed by other organizations. We also welcome developer to contribute your Transformer models! 🤗

```python
from paddlenlp.transformers import *
Expand Down Expand Up @@ -123,11 +122,11 @@ For more `TokenEmbedding` usage, please refer to [Embedding API](./docs/embeddin

Please find more API Reference from our [readthedocs](https://paddlenlp.readthedocs.io/).

## Rich Application Examples
## Wide-range NLP Task Support

PaddleNLP provide rich application examples covers mainstream NLP task to help developer accelerate problem solving.

### NLP Basic Technique
### NLP Basic Task

- [Word Embedding](./examples/word_embedding/)
- [Lexical Analysis](./examples/lexical_analysis/)
Expand All @@ -143,15 +142,15 @@ PaddleNLP provide rich application examples covers mainstream NLP task to help d
- [Semantic Indexing](./examples/semantic_indexing/)
- [Information Extraction](./examples/information_extraction/)

### NLP Application in Real System
### NLP Industrial Applications

- [Sentiment Analysis](./examples/sentiment_analysis/skep/):star2:
- [General Dialogue System](./examples/dialogue/)
- [Machine Translation](./examples/machine_translation/)
- [Simultaneous Translation](././examples/simultaneous_translation/)
- [Machine Reading Comprehension](./examples/machine_reading_comprehension/)

### Extention Application
### Extented Application

- [Text Knowledge Linking](./examples/text_to_knowledge/):star2:
- [Machine Reading Comprehension](./examples/machine_reading_comprehension)
Expand Down Expand Up @@ -191,7 +190,7 @@ Join our QQ Technical Group for technical exchange right now! ⬇️

## ChangeLog

For more information about our release, please refer to [ChangeLog](./docs/changelog.md)
For more details about our release, please refer to [ChangeLog](./docs/changelog.md)

## License

Expand Down

0 comments on commit f883e61

Please sign in to comment.