index_en.rst 3.4 KB
Newer Older
H
Hao Wang 已提交
1 2 3 4 5 6 7 8 9 10
###########
User Guides
###########

..  todo::

If you have got the hang of Beginner's Guide, and wish to model practical problems and build your original networks, this section will provide
you with some detailed operations:


11
This section collects several documents arranging from the simplest to the most challenging, which will guide you through the basic deep learning tasks in PaddlePaddle.
H
Hao Wang 已提交
12

13
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:
H
Hao Wang 已提交
14 15


16 17
Overview
======================
H
Hao Wang 已提交
18

19 20
   
    - `Simple Case <../user_guides/simple_case/index_en.html>`_ :introduces basic cases of Paddle
H
Hao Wang 已提交
21

22
    - `Natural Language Processing <../user_guides/nlp_case/index_en.html>`_:introduces cases of using paddle to realize Natural Language Processing tasks
H
Hao Wang 已提交
23

24 25 26
    - `Recommend <../user_guides/rec_case/index_en.html>`_:introduces cases of using paddle to realize Recommend tasks

	- `Models Zoo <../user_guides/models/index_en.html>`_:introduces the models zoo of Paddle
H
Hao Wang 已提交
27 28 29 30

..  toctree::
    :hidden:

31 32 33
    simple_case/index_en.rst
    nlp_case/index_en.rst
    rec_case/index_en.rst
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
	models/index_cn.rst


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 <https://www.docker.com/docker-windows>`_ or `Mac <https://www.docker.com/docker-mac>`_ , consider `allocate more Memory and CPU resources to Docker  <http://stackoverflow.com/a/39720010/724872>`_ .


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 <https://github.com/NVIDIA/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 <https://github.com/PaddlePaddle/book/blob/develop/.tools/convert-markdown-into-ipynb-and-test.sh>`_ to generate Docker image。

**Please Note:** We also provide `English Readme <https://github.com/PaddlePaddle/book/blob/develop/README.md>`_ for PaddlePaddle book