Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

English Document Structure #620

Merged
merged 9 commits into from
Nov 29, 2016
Merged

Conversation

gangliao
Copy link
Contributor

@gangliao gangliao commented Nov 25, 2016

Issue #558

@luotao1
Copy link
Contributor

luotao1 commented Nov 25, 2016

给个生成目录后的链接吧。这样很难review。

@gangliao
Copy link
Contributor Author

Preview

@luotao1
Copy link
Contributor

luotao1 commented Nov 28, 2016

  1. 首页的Introduction, Tutorials, How to, API, About需要全大写么?tensorflow的是全部大写的。
  2. Introduction的index页面如下,第二项是Basic Usage。
  • Basic Usage改成“A Simple Linear Regression Usage么”?
  • 这份文档的小标题重新组织下,标题中去掉12345的数字,第五小节“Where to Go from Here”可以全部去掉。标题1“A Classic Problem”改成“Problem Definition”?
  1. How to里面development guide可以全删掉,把write new layer拿出来放在howto的一级目录。How to的index目录顺序,按照字母顺序排列, 或者像Tutorials一样再分下类?
  2. API的index页面的三部分改成:1. DataProvider API 2. Model Config API 3. SWIG API ?

@wangkuiyi
Copy link
Collaborator

@gangliao 这个PR里混合了文档结构调整(git mv)和新增的几个文档——包括很重要的Get Started文档。以后最好每个PR做一个特定的事儿。要不然可能每一批comments都很多,这样迭代起来就慢了。

我写了一些comments,但是没有时间看完全部新增文档。你可以按照我写的comments举一反三。

另外,建议英语文档写作的时候用 Grammerly 检查用一下语法。

=======


Credits
Copy link
Collaborator

Choose a reason for hiding this comment

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

下面的内容都和credit没有关系。credit是“归功于谁”的意思。下面两段话应该是 About 下面的内容,最后一段关于authors的应该是 Credit 下面的内容。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


* [Model Config Interface](trainer_config_helpers/index.rst)

## Predict
Copy link
Collaborator

Choose a reason for hiding this comment

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

Predict 这个词得改一下。上次我们讨论是说到,Paddle不只是用来训练supervised model的。Predict应该改成“Applications”。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -0,0 +1,7 @@
Algorithm Configuration
Copy link
Collaborator

Choose a reason for hiding this comment

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

Algorithm是指递归、动态规划、分治策略、搜索剪枝这些事儿。和RNN没半毛钱关系。这里是不是Chinglish了?实际上想说的是 Deep Models 吗?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@@ -0,0 +1 @@
../../../tutorials/sentiment_analysis/bi_lstm.jpg
Copy link
Collaborator

Choose a reason for hiding this comment

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

这个文件是一个symlibic link吗?为什么需要给图像文件建立symbolic link呢?如果是在rst文章里引用,那么在rst文件里引用 ../../../tuturials/sentiment_analysis/bi_lstm.jpg不行吗?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

这个symlibic link是之前就有,我也觉得可以去掉。

@@ -0,0 +1 @@
../../../tutorials/text_generation/encoder-decoder-attention-model.png
Copy link
Collaborator

Choose a reason for hiding this comment

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

问题同上。

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Basic Usage
=============

PaddlePaddle is a deep learning platform open-sourced by Baidu. With PaddlePaddle, you can easily train a classic neural network within a couple lines of configuration, or you can build sophisticated models that provide state-of-the-art performance on difficult learning tasks like sentiment analysis, machine translation, image caption and so on.
Copy link
Collaborator

Choose a reason for hiding this comment

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

这一段可以简化成:

Let's run Paddle to learn a very simple linear regression model!

1. A Classic Problem
---------------------

Now, to give you a hint of what using PaddlePaddle looks like, let's start with a fundamental learning problem - `simple linear regression <https://en.wikipedia.org/wiki/Simple_linear_regression>`_: you have observed a set of two-dimensional data points of ``X`` and ``Y``, where ``X`` is an explanatory variable and ``Y`` is corresponding dependent variable, and you want to recover the underlying correlation between ``X`` and ``Y``. Linear regression can be used in many practical scenarios. For example, ``X`` can be a variable about house size, and ``Y`` a variable about house price. You can build a model that captures relationship between them by observing real estate markets.
Copy link
Collaborator

Choose a reason for hiding this comment

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

这一段写得和 https://en.wikipedia.org/wiki/Simple_linear_regression 里的描述重复了。我建议就用wikipedia里的原话,抄一遍就行

screen shot 2016-11-28 at 10 34 22 am

Copy link
Contributor Author

@gangliao gangliao Nov 29, 2016

Choose a reason for hiding this comment

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

@wangkuiyi 这篇其实不是我写的,我只是调整了文档所在的位置和格式风格。所以看起来是新增的。
要不先简单的改下,之后重新开一个PR, 单独改吧。

Copy link
Collaborator

Choose a reason for hiding this comment

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

了解了。好的。


Now, to give you a hint of what using PaddlePaddle looks like, let's start with a fundamental learning problem - `simple linear regression <https://en.wikipedia.org/wiki/Simple_linear_regression>`_: you have observed a set of two-dimensional data points of ``X`` and ``Y``, where ``X`` is an explanatory variable and ``Y`` is corresponding dependent variable, and you want to recover the underlying correlation between ``X`` and ``Y``. Linear regression can be used in many practical scenarios. For example, ``X`` can be a variable about house size, and ``Y`` a variable about house price. You can build a model that captures relationship between them by observing real estate markets.

2. Prepare the Data
Copy link
Collaborator

Choose a reason for hiding this comment

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

Prepare the Data 表意不明确—— 之前并没有提到什么data,何来 the data呢?

另外,这一节介绍的实际内容是 Load the Training Data,就以此为标题好了。

2. Prepare the Data
--------------------

Suppose the true relationship can be characterized as ``Y = 2X + 0.3``, let's see how to recover this pattern only from observed data. Here is a piece of python code that feeds synthetic data to PaddlePaddle. The code is pretty self-explanatory, the only extra thing you need to add for PaddlePaddle is a definition of input data types.
Copy link
Collaborator

Choose a reason for hiding this comment

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

这一节的重点是要介绍Paddle job通常是通过 Python 写的 data provider 来读取数据的。所以第一段的第一句应该是介绍 data provider的。比如:

A PaddlePaddle job usually loads the training data by implementing a Python data provider. A data provider is a Python function which is called by PaddlePaddel trainer program, so it could adapt to any data format. We can write data provider to read from local filesystem, HDFS, databases, S3 or almost anywhere. In this example, our data provider synthesize the training data by sampling from the line Y=2X + 0.3.

x = random.random()
yield [x], [2*x+0.3]

3. Train a NeuralNetwork
Copy link
Collaborator

Choose a reason for hiding this comment

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

NeuralNetwork ==> Neural Network

@wangkuiyi
Copy link
Collaborator

@gangliao 我approve了。但是有几个我提出的问题,请创建相应的issue,以备未来发心的PR进一步修正吧。

另外,我看 @luotao1 还有几个问题,merge之前请确保也解决了 @luotao1 的问题吧。

@gangliao gangliao merged commit f8ec510 into PaddlePaddle:develop Nov 29, 2016
@gangliao gangliao deleted the docstructure branch November 29, 2016 07:55
zhhsplendid pushed a commit to zhhsplendid/Paddle that referenced this pull request Sep 25, 2019
* remove v2

* remove mobile

* fix_02
heavengate pushed a commit to heavengate/Paddle that referenced this pull request Aug 24, 2022
…ective_recompute

fused linear and selective recompute
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants