Add embeddings.md to readthedocs (PaddlePaddle#503)

* add embeddings.md to readthedocs * Update README.md
hrbxmt · Jun 7, 2021 · 6198f53 · 6198f53
1 parent 40d2597
commit 6198f53
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 10 deletions.
diff --git a/README_en.md b/README_en.md
@@ -120,7 +120,7 @@ For more `TokenEmbedding` usage, please refer to [Embedding API](./docs/embeddin
 - [Transformer API](./docs/model_zoo/transformers.rst)
 - [Data API](./docs/data.md)
 - [Dataset API](./docs/datasets.md)
-- [Embedding API](./docs/embeddings.md)
+- [Embedding API](./docs/model_zoo/embeddings.md)
 - [Metrics API](./docs/metrics.md)
 
 Please find more API Reference from our [readthedocs](https://paddlenlp.readthedocs.io/).

diff --git a/docs/index.rst b/docs/index.rst
@@ -44,8 +44,8 @@
    :maxdepth: 2
    :caption: 模型库
 
-   预训练模型 <model_zoo/transformers>
-   基本组网单元 <model_zoo/others>
+   Transformer预训练模型 <model_zoo/transformers>
+   预训练词向量 <model_zoo/embeddings>
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/embeddings.md → docs/model_zoo/embeddings.md b/docs/embeddings.md → docs/model_zoo/embeddings.md
diff --git a/docs/model_zoo/others.rst b/docs/model_zoo/others.rst
diff --git a/examples/word_embedding/README.md b/examples/word_embedding/README.md
@@ -44,7 +44,7 @@ python train.py --device='gpu' \
 
 * `save_dir`: 模型保存目录。默认值为"./checkpoints/"。
 * `init_from_ckpt`: 恢复模型训练的断点路径。默认值为None，表示不恢复训练。
-* `embedding_name`: 预训练Embedding名称，默认为`w2v.baidu_encyclopedia.target.word-word.dim300`. 支持的预训练Embedding可参考[Embedding 模型汇总](../../docs/embeddings.md)。
+* `embedding_name`: 预训练Embedding名称，默认为`w2v.baidu_encyclopedia.target.word-word.dim300`. 支持的预训练Embedding可参考[Embedding 模型汇总](../../docs/model_zoo/embeddings.md)。
 
 **注意：**
 

diff --git a/paddlenlp/embeddings/README.md b/paddlenlp/embeddings/README.md
@@ -4,7 +4,7 @@
 
 |  参数 | 类型  | 属性  |
 | ------------ | ------------ | ------------ |
-| embedding_name | **string**  | 预训练embedding名称，可通过paddlenlp.embeddings.list_embedding_name或[Embedding 模型汇总](../../docs/embeddings.md)查询。 |
+| embedding_name | **string**  | 预训练embedding名称，可通过paddlenlp.embeddings.list_embedding_name()或[Embedding 模型汇总](../../docs/model_zoo/embeddings.md)查询。 |
 | unknown_token | **string**  | unknown token。 |
 | unknown_token_vector | **list** 或者 **np.array** | 用来初始化unknown token对应的vector。默认为None（以正态分布方式初始化vector）|
 | extended_vocab_path | **string**  | 扩展词表的文件名路径。词表格式为一行一个词。 |