diff --git a/PaddleNLP/README.md b/PaddleNLP/README.md index a4efb36231d8ac579996bca0c35ad032bd8e8756..1619754eba9cda0700d46400626baff2fb8a3bf3 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 0000000000000000000000000000000000000000..915ed6784a406764415326efd7436bcea3e80c7d --- /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 0000000000000000000000000000000000000000..6197d19d38a99227ba61723ec5eef5c4d6f99434 --- /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 0000000000000000000000000000000000000000..bc0859b68ded9f0d415d443964f82fc16be87cc6 --- /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 0000000000000000000000000000000000000000..dcfbcee1d2fa42f01375d6b11f6c0b218619768a --- /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 0000000000000000000000000000000000000000..b9f36b643ebaa47f6bc51643916b8821edadc703 --- /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 0000000000000000000000000000000000000000..97a612c540e4fc76cbcfb57d0cc42078e9d62bd1 --- /dev/null +++ b/PaddleNLP/docs/transformers.md @@ -0,0 +1 @@ +# 汇总paddlenlp.transformer下预训练模型