From 645aa942a54bf9e111628d72ffffed2323186ef2 Mon Sep 17 00:00:00 2001 From: Hao Wang <31058429+haowang101779990@users.noreply.github.com> Date: Sat, 9 Mar 2019 10:18:36 +0800 Subject: [PATCH] book indexes (#677) --- .../basics/image_classification/index_en.md | 1 + doc/fluid/beginners_guide/basics/index_en.rst | 99 +++++++++++++++++++ .../basics/label_semantic_roles/index_en.md | 1 + .../basics/machine_translation/index_en.md | 1 + .../basics/recommender_system/index_en.md | 1 + .../basics/understand_sentiment/index_en.md | 1 + .../basics/word2vec/index_en.md | 1 + doc/fluid/beginners_guide/index_en.rst | 2 + .../quick_start/fit_a_line/README.md | 1 + .../beginners_guide/quick_start/index_en.rst | 13 +++ .../quick_start/recognize_digits/README.md | 1 + 11 files changed, 122 insertions(+) create mode 120000 doc/fluid/beginners_guide/basics/image_classification/index_en.md create mode 100644 doc/fluid/beginners_guide/basics/index_en.rst create mode 120000 doc/fluid/beginners_guide/basics/label_semantic_roles/index_en.md create mode 120000 doc/fluid/beginners_guide/basics/machine_translation/index_en.md create mode 120000 doc/fluid/beginners_guide/basics/recommender_system/index_en.md create mode 120000 doc/fluid/beginners_guide/basics/understand_sentiment/index_en.md create mode 120000 doc/fluid/beginners_guide/basics/word2vec/index_en.md create mode 120000 doc/fluid/beginners_guide/quick_start/fit_a_line/README.md create mode 100644 doc/fluid/beginners_guide/quick_start/index_en.rst create mode 120000 doc/fluid/beginners_guide/quick_start/recognize_digits/README.md diff --git a/doc/fluid/beginners_guide/basics/image_classification/index_en.md b/doc/fluid/beginners_guide/basics/image_classification/index_en.md new file mode 120000 index 000000000..5a881dd1b --- /dev/null +++ b/doc/fluid/beginners_guide/basics/image_classification/index_en.md @@ -0,0 +1 @@ +../../../../../external/book/03.image_classification/README.md \ No newline at end of file diff --git a/doc/fluid/beginners_guide/basics/index_en.rst b/doc/fluid/beginners_guide/basics/index_en.rst new file mode 100644 index 000000000..97efb54d1 --- /dev/null +++ b/doc/fluid/beginners_guide/basics/index_en.rst @@ -0,0 +1,99 @@ +########################## +Basic Deep Learning Models +########################## + +This section collects six documents arranging from the simplest to the most challenging, which will guide you through the basic deep learning tasks in PaddlePaddle. + +The documentation in this chapter covers a lot of deep learning basics and how to implement them with PaddlePaddle. See the instructions below for how to use: + + +Overview +====================== + +The book you are reading is an "interactive" e-book - each chapter can be run in a Jupyter Notebook. + +.. toctree:: + :titlesonly: + + image_classification/index_en.md + word2vec/index_en.md + recommender_system/index_en.md + understand_sentiment/index_en.md + label_semantic_roles/index_en.md + machine_translation/index_en.md + + +We packaged Jupyter, PaddlePaddle, and various dependency softwares into a Docker image. It frees you from installing these softwares by yourself, and you only need to just install Docker. For various Linux versions, please refer to https://www.docker.com . If you use docker on `Windows `_ or `Mac `_ , consider `allocate more Memory and CPU resources to Docker `_ . + + +Instructions +====================== + + +This book assumes you are performing CPU training by default. If you want to use GPU training, the steps will vary slightly. Please refer to "GPU Training" below. + + + + + +CPU training +>>>>>>>>>>>> + +Just run these in shell: + +.. code-block:: shell + + docker run -d -p 8888:8888 paddlepaddle/book + +It downloads the Docker image for running books from DockerHub.com. +To read and edit this book on-line, please visit http://localhost:8888 in your browser. + +If the Internet connection to DockerHub.com is compromised, try our spare docker image named docker.paddlepaddlehub.com: + +:: + + docker run -d -p 8888:8888 docker.paddlepaddlehub.com/book + + +GPU training +>>>>>>>>>>>>> + +To ensure that the GPU driver works properly in the image, we recommend running the image with `nvidia docker `_ . Please install nvidia-docker first, then run: + + +:: + + nvidia-docker run -d -p 8888:8888 paddlepaddle/book:latest-gpu + + +Or use a image source in China to run: + +:: + + nvidia-docker run -d -p 8888:8888 docker.paddlepaddlehub.com/book:latest-gpu + + +modify the following codes + +.. code-block:: python + + use_cuda = False + + +into : + +.. code-block:: python + + use_cuda = True + + + +Contribute to Book +=================== + +We highly appreciate your original contributions of new chapters to Book! Just Pull Requests of your contributions to the sub-directory in :code:`pending` . When this chapter is endorsed, we'll gladly move it to the root directory. + + +For writing, running, debugging, you need to install `shell `_ to generate Docker image。 + +**Please Note:** We also provide `English Readme `_ for PaddlePaddle book diff --git a/doc/fluid/beginners_guide/basics/label_semantic_roles/index_en.md b/doc/fluid/beginners_guide/basics/label_semantic_roles/index_en.md new file mode 120000 index 000000000..4f309fd57 --- /dev/null +++ b/doc/fluid/beginners_guide/basics/label_semantic_roles/index_en.md @@ -0,0 +1 @@ +../../../../../external/book/07.label_semantic_roles/README.md \ No newline at end of file diff --git a/doc/fluid/beginners_guide/basics/machine_translation/index_en.md b/doc/fluid/beginners_guide/basics/machine_translation/index_en.md new file mode 120000 index 000000000..af007364d --- /dev/null +++ b/doc/fluid/beginners_guide/basics/machine_translation/index_en.md @@ -0,0 +1 @@ +../../../../../external/book/08.machine_translation/README.md \ No newline at end of file diff --git a/doc/fluid/beginners_guide/basics/recommender_system/index_en.md b/doc/fluid/beginners_guide/basics/recommender_system/index_en.md new file mode 120000 index 000000000..3892d78c0 --- /dev/null +++ b/doc/fluid/beginners_guide/basics/recommender_system/index_en.md @@ -0,0 +1 @@ +../../../../../external/book/05.recommender_system/README.md \ No newline at end of file diff --git a/doc/fluid/beginners_guide/basics/understand_sentiment/index_en.md b/doc/fluid/beginners_guide/basics/understand_sentiment/index_en.md new file mode 120000 index 000000000..f330a8250 --- /dev/null +++ b/doc/fluid/beginners_guide/basics/understand_sentiment/index_en.md @@ -0,0 +1 @@ +../../../../../external/book/06.understand_sentiment/README.md \ No newline at end of file diff --git a/doc/fluid/beginners_guide/basics/word2vec/index_en.md b/doc/fluid/beginners_guide/basics/word2vec/index_en.md new file mode 120000 index 000000000..c2e95a166 --- /dev/null +++ b/doc/fluid/beginners_guide/basics/word2vec/index_en.md @@ -0,0 +1 @@ +../../../../../external/book/04.word2vec/README.md \ No newline at end of file diff --git a/doc/fluid/beginners_guide/index_en.rst b/doc/fluid/beginners_guide/index_en.rst index 3e60ffb58..eaa0d1a0f 100644 --- a/doc/fluid/beginners_guide/index_en.rst +++ b/doc/fluid/beginners_guide/index_en.rst @@ -24,4 +24,6 @@ If you have been armed with certain level of deep learning knowledge, and it hap :hidden: install/index_en.rst + quick_start/index_en.rst + basics/index_en.rst programming_guide/programming_guide_en.md diff --git a/doc/fluid/beginners_guide/quick_start/fit_a_line/README.md b/doc/fluid/beginners_guide/quick_start/fit_a_line/README.md new file mode 120000 index 000000000..2213def63 --- /dev/null +++ b/doc/fluid/beginners_guide/quick_start/fit_a_line/README.md @@ -0,0 +1 @@ +../../../../../external/book/01.fit_a_line/README.md \ No newline at end of file diff --git a/doc/fluid/beginners_guide/quick_start/index_en.rst b/doc/fluid/beginners_guide/quick_start/index_en.rst new file mode 100644 index 000000000..6964c43de --- /dev/null +++ b/doc/fluid/beginners_guide/quick_start/index_en.rst @@ -0,0 +1,13 @@ +############## +Quick Start +############## + +Welcome to Quick Start! + +This section will tutor you to invent your won models of classical *linear Regression* and *Handwritten Digits Recognition* tasks in PaddlePaddle Fluid. The following tutorials provide details on model definition, training, and inference in a friendly manner based on real-life datasets: + +.. toctree:: + :titlesonly: + + fit_a_line/README.md + recognize_digits/README.md diff --git a/doc/fluid/beginners_guide/quick_start/recognize_digits/README.md b/doc/fluid/beginners_guide/quick_start/recognize_digits/README.md new file mode 120000 index 000000000..d1f0a6280 --- /dev/null +++ b/doc/fluid/beginners_guide/quick_start/recognize_digits/README.md @@ -0,0 +1 @@ +../../../../../external/book/02.recognize_digits/README.md \ No newline at end of file -- GitLab