Skip to content
This repository was archived by the owner on Jan 24, 2024. It is now read-only.

moidfy Bookreadme #232

Merged
merged 6 commits into from
Mar 20, 2017
Merged

moidfy Bookreadme #232

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4996104
add build method
gongweibao Mar 20, 2017
d3c0618
fix
gongweibao Mar 20, 2017
871704b
fix paddledev
gongweibao Mar 20, 2017
4ac4f98
Update English description about running the book
wangkuiyi Mar 20, 2017
d3f1cf6
Fix formatting errors
wangkuiyi Mar 20, 2017
b7d65e6
Shorten
wangkuiyi Mar 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,41 @@
1. [Machine Translation](http://book.paddlepaddle.org/machine_translation/index.en.html)
1. [Recommender System](http://book.paddlepaddle.org/recommender_system/index.en.html)

# Reading Using Docker
Copy link
Collaborator

@wangkuiyi wangkuiyi Mar 20, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Running the Book

This book you are reading is interactive -- each chapter can run as a Jupyter Notebook.

Install Docker

We packed Jupyter, PaddlePaddle, and all dependencies into a Docker image. So you don't need to install anything except Docker. If you are using Windows, please following this instruction. If you are running Mac, please follow this. For various Linux distros, please refer to https://www.docker.com. If you are using Windows or Mac, you might want to give Docker more memory and CPUs/cores.

Run the Book

Just type

docker run -d -p 8888:8888 paddlepaddle/book

This command will download the pre-built Docker image from DockerHub.com and run it in a container. Please direct your Web browser to http://localhost:8888 to read the book.

If you are living in somewhere slow to access DockerHub.com, you might try our mirror server docker.paddlepaddle.org:

docker run -d -p 8888:8888 docker.paddlepaddle.org/book

Contribute

Your contribution is welcome! Please feel free to file Pull Requests to add your chapter as a directory under /pending. Once it is going stable, the community would like to move it to /.

To write, run, and debug your chapters, you will need Python 2.x, Go >1.5. You can build the Docker image using this script.

You can read this book and test the notebookfile using Docker. If you can access dockerhub, run it as
```bash
docker run -d -p 8888:8888 paddlepaddle/book
```

Or if you are in china mainland, you can use
```bash
docker run -d -p 8888:8888 docker.paddlepaddle.org/book
```

Then open the url http://ip:8888/, such as:
```
http://localhost:8888/
```

# How to build book's docker image
1.prepare your docker environment, make sure you can run docker command

```bash
docker
```

2.get go [here](https://storage.googleapis.com/golang/go1.8.linux-amd64.tar.gz)

3.get book source code and build it

```bash
git clone https://github.com/PaddlePaddle/book.git
cd book/
.tools/build_docker.sh
```

# How to get paddlepaddle docker image
This book's docker image depends on paddlepaddle docker image. Paddlepaddle's document is [here](https://github.com/PaddlePaddle/Paddle/tree/develop/paddle/scripts/docker)


This tutorial is contributed by <a xmlns:cc="http://creativecommons.org/ns#" href="http://book.paddlepaddle.org" property="cc:attributionName" rel="cc:attributionURL">PaddlePaddle</a>, and licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.