Skip to content

Commit dad11db

Browse files
authored
Merge pull request #807 from reyoung/feature/fix_dead_link_in_rec
Fix dead link after rearrange english documentation.
2 parents b6aca33 + 469ea64 commit dad11db

File tree

9 files changed

+58
-40
lines changed

9 files changed

+58
-40
lines changed

doc/api/data_provider/pydataprovider2_en.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
.. _api_pydataprovider:
2+
13
PyDataProvider2
2-
=================
4+
===============
35

46
We highly recommand users to use PyDataProvider2 to provide training or testing
57
data to PaddlePaddle. The user only needs to focus on how to read a single

doc/api/index_en.rst

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,37 @@
11
API
2-
====
2+
===
33

44
DataProvider API
55
----------------
66

77
.. toctree::
8-
:maxdepth: 1
8+
:maxdepth: 1
99

10-
data_provider/index_en.rst
11-
data_provider/pydataprovider2_en.rst
10+
data_provider/index_en.rst
11+
data_provider/pydataprovider2_en.rst
12+
13+
.. _api_trainer_config:
1214

1315
Model Config API
1416
----------------
1517

1618
.. toctree::
17-
:maxdepth: 1
19+
:maxdepth: 1
1820

19-
trainer_config_helpers/optimizers.rst
20-
trainer_config_helpers/data_sources.rst
21-
trainer_config_helpers/layers.rst
22-
trainer_config_helpers/activations.rst
23-
trainer_config_helpers/poolings.rst
24-
trainer_config_helpers/networks.rst
25-
trainer_config_helpers/evaluators.rst
26-
trainer_config_helpers/attrs.rst
21+
trainer_config_helpers/optimizers.rst
22+
trainer_config_helpers/data_sources.rst
23+
trainer_config_helpers/layers.rst
24+
trainer_config_helpers/activations.rst
25+
trainer_config_helpers/poolings.rst
26+
trainer_config_helpers/networks.rst
27+
trainer_config_helpers/evaluators.rst
28+
trainer_config_helpers/attrs.rst
2729

2830

2931
Applications API
3032
----------------
3133

3234
.. toctree::
33-
:maxdepth: 1
35+
:maxdepth: 1
3436

35-
predict/swig_py_paddle_en.rst
37+
predict/swig_py_paddle_en.rst

doc/api/trainer_config_helpers/data_sources.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _api_trainer_config_helpers_data_sources:
2+
13
DataSources
24
===========
35

doc/api/trainer_config_helpers/layers.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ LayerOutput
2020
Data layer
2121
===========
2222

23+
.. _api_trainer_config_helpers_layers_data_layer:
24+
2325
data_layer
2426
----------
2527
.. automodule:: paddle.trainer_config_helpers.layers
@@ -29,6 +31,8 @@ data_layer
2931
Fully Connected Layers
3032
======================
3133

34+
.. _api_trainer_config_helpers_layers_fc_layer:
35+
3236
fc_layer
3337
--------
3438
.. automodule:: paddle.trainer_config_helpers.layers
@@ -68,6 +72,8 @@ img_conv_layer
6872
:members: img_conv_layer
6973
:noindex:
7074

75+
.. _api_trainer_config_helpers_layers_context_projection:
76+
7177
context_projection
7278
------------------
7379
.. automodule:: paddle.trainer_config_helpers.layers
@@ -185,6 +191,8 @@ mixed_layer
185191
:members: mixed_layer
186192
:noindex:
187193

194+
.. _api_trainer_config_helpers_layers_embedding_layer:
195+
188196
embedding_layer
189197
---------------
190198
.. automodule:: paddle.trainer_config_helpers.layers
@@ -237,6 +245,8 @@ trans_full_matrix_projection
237245
Aggregate Layers
238246
================
239247

248+
.. _api_trainer_config_helpers_layers_pooling_layer:
249+
240250
pooling_layer
241251
-------------
242252
.. automodule:: paddle.trainer_config_helpers.layers
@@ -333,6 +343,8 @@ tensor_layer
333343
:members: tensor_layer
334344
:noindex:
335345

346+
.. _api_trainer_config_helpers_layers_cos_sim:
347+
336348
cos_sim
337349
-------
338350
.. automodule:: paddle.trainer_config_helpers.layers

doc/api/trainer_config_helpers/networks.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ sequence_conv_pool
1313
:members: sequence_conv_pool
1414
:noindex:
1515

16+
.. _api_trainer_config_helpers_network_text_conv_pool:
17+
1618
text_conv_pool
1719
--------------
1820
.. automodule:: paddle.trainer_config_helpers.networks

doc/conf.py.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,5 +144,6 @@ def setup(app):
144144
# no c++ API for now
145145
app.add_config_value('recommonmark_config', {
146146
'url_resolver': lambda url: github_doc_root + url,
147+
'enable_eval_rst': True,
147148
}, True)
148149
app.add_transform(AutoStructify)

doc/howto/cmd_parameter/index_en.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
```eval_rst
2+
.. _cmd_line_index_en:
3+
```
14
# How to Set Command-line Parameters
25

36
* [Use Case](use_case_en.md)

doc/tutorials/rec/ml_dataset_en.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
```eval_rst
2+
.. _demo_ml_dataset_en:
3+
4+
```
5+
16
# MovieLens Dataset
27

38
The [MovieLens Dataset](http://grouplens.org/datasets/movielens/) was collected by GroupLens Research.

doc/tutorials/rec/ml_regression_en.rst

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Data Preparation
1616
````````````````
1717
Download and extract dataset
1818
''''''''''''''''''''''''''''
19-
We use `movielens 1m dataset <ml_dataset.html>`_ here.
19+
We use :ref:`demo_ml_dataset_en` here.
2020
To download and unzip the dataset, simply run the following commands.
2121

2222
.. code-block:: bash
@@ -239,26 +239,16 @@ Then we combine each features of movie into one movie feature by a
239239
get one user feature. Then we calculate the cosine similarity of these two
240240
features.
241241

242-
In these network, we use several api in `trainer_config_helpers
243-
<../../ui/api/trainer_config_helpers/index.html>`_. There are
244-
245-
* Data Layer, `data_layer
246-
<../../ui/api/trainer_config_helpers/layers.html#id1>`_
247-
* Fully Connected Layer, `fc_layer
248-
<../../ui/api/trainer_config_helpers/layers.html#fc-layer>`_
249-
* Embedding Layer, `embedding_layer
250-
<../../ui/api/trainer_config_helpers/layers.html#embedding-layer>`_
251-
* Context Projection Layer, `context_projection
252-
<../../ui/api/trainer_config_helpers/layers.html#context-projection>`_
253-
* Pooling Layer, `pooling_layer
254-
<../../ui/api/trainer_config_helpers/layers.html#pooling-layer>`_
255-
* Cosine Similarity Layer, `cos_sim
256-
<../../ui/api/trainer_config_helpers/layers.html#cos-sim>`_
257-
* Text Convolution Pooling Layer, `text_conv_pool
258-
<../../ui/api/trainer_config_helpers/networks.html
259-
#trainer_config_helpers.networks.text_conv_pool>`_
260-
* Declare Python Data Sources, `define_py_data_sources2
261-
<../../ui/api/trainer_config_helpers/data_sources.html>`_
242+
In these network, we use several api in :ref:`api_trainer_config` . There are
243+
244+
* Data Layer, :ref:`api_trainer_config_helpers_layers_data_layer`
245+
* Fully Connected Layer, :ref:`api_trainer_config_helpers_layers_fc_layer`
246+
* Embedding Layer, :ref:`api_trainer_config_helpers_layers_embedding_layer`
247+
* Context Projection Layer, :ref:`api_trainer_config_helpers_layers_context_projection`
248+
* Pooling Layer, :ref:`api_trainer_config_helpers_layers_pooling_layer`
249+
* Cosine Similarity Layer, :ref:`api_trainer_config_helpers_layers_cos_sim`
250+
* Text Convolution Pooling Layer, :ref:`api_trainer_config_helpers_network_text_conv_pool`
251+
* Declare Python Data Sources :ref:`api_trainer_config_helpers_data_sources`.
262252

263253
Data Provider
264254
'''''''''''''
@@ -274,7 +264,7 @@ In this :code:`dataprovider.py`, we should set\:
274264
* use_seq\: Whether this :code:`dataprovider.py` in sequence mode or not.
275265
* process\: Return each sample of data to :code:`paddle`.
276266

277-
The data provider details document see `there <../../ui/data_provider/pydataprovider2.html>`_.
267+
The data provider details document see :ref:`api_pydataprovider`.
278268

279269
Train
280270
`````
@@ -290,8 +280,7 @@ The run.sh is shown as follow:
290280
It just start a paddle training process, write the log to `log.txt`,
291281
then print it on screen.
292282

293-
Each command line argument in :code:`run.sh`, please refer to the `command line
294-
arguments <../../ui/index.html#command-line-argument>`_ page. The short description of these arguments is shown as follow.
283+
Each command line argument in :code:`run.sh`, please refer to the :ref:`cmd_line_index_en` page. The short description of these arguments is shown as follow.
295284

296285
* config\: Tell paddle which file is neural network configuration.
297286
* save_dir\: Tell paddle save model into './output'

0 commit comments

Comments
 (0)