From 4500f3fd173517ad4077dbccbf792df431a7cfdd Mon Sep 17 00:00:00 2001 From: Zeyu Chen Date: Sat, 12 Dec 2020 11:05:50 +0800 Subject: [PATCH] add api usage docs --- PaddleNLP/README.md | 10 +++++++++- PaddleNLP/README_cn.md | 1 + PaddleNLP/docs/datasets.md | 3 +++ PaddleNLP/docs/embeddings.md | 3 +++ PaddleNLP/docs/metrics.md | 1 + PaddleNLP/docs/models.md | 3 +++ PaddleNLP/docs/transformers.md | 1 + 7 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 PaddleNLP/README_cn.md create mode 100644 PaddleNLP/docs/datasets.md create mode 100644 PaddleNLP/docs/embeddings.md create mode 100644 PaddleNLP/docs/metrics.md create mode 100644 PaddleNLP/docs/models.md create mode 100644 PaddleNLP/docs/transformers.md diff --git a/PaddleNLP/README.md b/PaddleNLP/README.md index a4efb362..1619754e 100644 --- a/PaddleNLP/README.md +++ b/PaddleNLP/README.md @@ -73,6 +73,14 @@ roberta = RobertaModel.from_pretrained('roberta-wwm-ext') For more pretrained model selection, please refer to [PretrainedModels](./paddlenlp/transformers/README.md) +## API Usage + +* Transformer API(./docs/transformers.md) +* Dataset API(./docs/datasets.md) +* Embedding API(./docs/embeddings.md) +* Metrics API(./docs/embeddings.md) +* Models API(./docs/models.md) + ## Tutorials List our notebook tutorials based on AI Studio. @@ -88,4 +96,4 @@ TBD ## License -PaddleNLP is provided under the [Apache-2.0 License](./LICENSE). \ No newline at end of file +PaddleNLP is provided under the [Apache-2.0 License](./LICENSE). diff --git a/PaddleNLP/README_cn.md b/PaddleNLP/README_cn.md new file mode 100644 index 00000000..915ed678 --- /dev/null +++ b/PaddleNLP/README_cn.md @@ -0,0 +1 @@ +# PaddleNLP 中文README diff --git a/PaddleNLP/docs/datasets.md b/PaddleNLP/docs/datasets.md new file mode 100644 index 00000000..6197d19d --- /dev/null +++ b/PaddleNLP/docs/datasets.md @@ -0,0 +1,3 @@ +# paddlenlp.datasets集成的API清单 + +以表格形式汇总，需要至少包含数据类型，数据介绍，数据API diff --git a/PaddleNLP/docs/embeddings.md b/PaddleNLP/docs/embeddings.md new file mode 100644 index 00000000..bc0859b6 --- /dev/null +++ b/PaddleNLP/docs/embeddings.md @@ -0,0 +1,3 @@ +# Embedding 模型汇总 + +包括中英文参数，表格形式汇总 diff --git a/PaddleNLP/docs/metrics.md b/PaddleNLP/docs/metrics.md new file mode 100644 index 00000000..dcfbcee1 --- /dev/null +++ b/PaddleNLP/docs/metrics.md @@ -0,0 +1 @@ +# paddlenlp.metrics API汇总 diff --git a/PaddleNLP/docs/models.md b/PaddleNLP/docs/models.md new file mode 100644 index 00000000..b9f36b64 --- /dev/null +++ b/PaddleNLP/docs/models.md @@ -0,0 +1,3 @@ +# paddlenlp.models + +高阶组网API说明，Ernie, SimNet, Senta diff --git a/PaddleNLP/docs/transformers.md b/PaddleNLP/docs/transformers.md new file mode 100644 index 00000000..97a612c5 --- /dev/null +++ b/PaddleNLP/docs/transformers.md @@ -0,0 +1 @@ +# 汇总paddlenlp.transformer下预训练模型 -- GitLab