update docs of Hello World sample

Oceania2018 · Oceania2018 · commit 1344277eb401 · 2019-01-05T12:13:55.000-06:00
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@ TensorFlow.NET provides .NET Standard binding for [TensorFlow](https://www.tenso
 [![Tensorflow.NET](https://ci.appveyor.com/api/projects/status/wx4td43v2d3f2xj6?svg=true)](https://ci.appveyor.com/project/Haiping-Chen/tensorflow-net)
 [![codecov](https://codecov.io/gh/SciSharp/NumSharp/branch/master/graph/badge.svg)](https://codecov.io/gh/SciSharp/NumSharp)
 [![NuGet](https://img.shields.io/nuget/dt/TensorFlow.NET.svg)](https://www.nuget.org/packages/TensorFlow.NET)
+[![Documentation Status](https://readthedocs.org/projects/tensorflownet/badge/?version=latest)](https://tensorflownet.readthedocs.io/en/latest/?badge=latest)
 
 TensorFlow.NET is a member project of [SciSharp](https://github.com/SciSharp) stack.
 
@@ -54,4 +55,6 @@ using(var sess = tf.Session())
 }
 ```
 
-Star me or raise issue on [Github](https://github.com/SciSharp/TensorFlow.NET) feel free.
+Read the docs & book [The Definitive Guide to Tensorflow.NET](https://tensorflownet.readthedocs.io/en/latest/FrontCover.html).
+
+Star me or raise issue on [Github](https://github.com/SciSharp/TensorFlow.NET) feel free.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,16 @@
+### Instll Sphinx
+```cmd
+pip install sphinx
+pip install recommonmark
+pip install sphinx_rtd_theme
+```
+
+### Init the docs
+```cmd
+sphinx-quickstarts
+```
+
+### Build the docs
+```cmd
+make html
+```
diff --git a/docs/source/FrontCover.md b/docs/source/FrontCover.md
@@ -9,7 +9,11 @@
 
 
 
-![column-major order](_static/cover.jpg)
+![Front Cover](_static/front-cover.jpg)
+
+
+
+
 
 
 
@@ -19,9 +23,13 @@
 
 #### An Open Source Machine Learning Framework for Everyone
 
-### 谷歌TensorFlow的C#封装库
+### 谷歌TensorFlow的C#绑定库
+
+#### 人人都可用的开源机器学习框架。
+
+
+
 
-#### 开源机器学习框架。
 
 
 
@@ -30,13 +38,14 @@
 
 
 <p style='float:right;'> 
-Haiping Chen & Christian Kahr<br/>
-Christmas, 2018<br/>
-陈海平 & 克里斯汀 卡尔<br/>
-2018年圣诞节
+<b>Haiping Chen & Christian Kahr</b><br/>
+<b>Christmas, 2018</b><br/>
+<b>陈海平 & 克里斯汀·卡尔</b><br/>
+<b>2018年圣诞节</b>
 </p>
 
 
 
 
 
+
diff --git a/docs/source/HelloWorld.md b/docs/source/HelloWorld.md
@@ -1,14 +1,70 @@
-# Get started with TensorFlow.NET
+# 	Get started with TensorFlow.NET
 
-让我们先运行一个经典的HelloWorld程序，看看TensorFlow是在.NET上面运行的效果，我想不出有比做个HelloWorld再简单的方式了。
+让我们先运行一个经典的HelloWorld程序，看看TensorFlow在.NET上面运行的效果，我想不出有比做个HelloWorld更简单的方式了。
 
 Let's run a classic HelloWorld program first and see if TensorFlow is running on .NET. I can't think of a simpler way to be a HelloWorld.
 
-### Install the TensorFlow.NET SDK
+### Install the TensorFlow.NET SDK 安装开发环境
+
+TensorFlow.NET uses the .NET Standard 2.0 standard, so your new project Target Framework can be .NET Framework or .NET Core.  All the examples in this book are using .NET Core 2.2 and Microsoft Visual Studio Community 2017. To start building TensorFlow program you just need to download and install the .NET SDK (Software Development Kit). You have to download the latest .NET Core SDK from offical website: https://dotnet.microsoft.com/download.
+
+TensorFlow.NET采用.NET标准库2.0版本，因此你的新建工程可以是.NET Framework或者是基于.NET Core的。本文中的所有例子都是用的.NET Core 2.2的，IDE用的是Microsoft Visual Studio Community 2017。为了能编译和运行TensorFlow工程，你需要从这里下载最新的.NET Core SDK: https://dotnet.microsoft.com/download。
+
+1. New a project
+
+   ![New Project](_static/new-project.png)
+
+2. Choose Console App (.NET Core)
+
+   ![Console App](_static/new-project-console.png)
+
 
-To start building TensorFlow program you just need to download and install the .NET SDK (Software Development Kit).
 
 ```cmd
 PM> Install-Package TensorFlow.NET
 ```
 
+### Start coding Hello World 开始编写Hello World
+
+After installing the TensorFlow.NET package, you can use the `using Tensorflow` to introduce the TensorFlow library.
+
+安装完TensorFlow.NET包后，你就可以使用`using Tensorflow`来引入TensorFlow库了。
+
+```csharp
+using System;
+using Tensorflow;
+
+namespace TensorFlowNET.Examples
+{
+    /// <summary>
+    /// Simple hello world using TensorFlow
+    /// </summary>
+    public class HelloWorld : IExample
+    {
+        public void Run()
+        {
+            /* Create a Constant op
+               The op is added as a node to the default graph.
+            
+               The value returned by the constructor represents the output
+               of the Constant op. */
+            var hello = tf.constant("Hello, TensorFlow!");
+
+            // Start tf session
+            using (var sess = tf.Session())
+            {
+                // Run the op
+                var result = sess.run(hello);
+                Console.WriteLine(result);
+            }
+        }
+    }
+}
+```
+After CTRL + F5 run, you will get the output.
+```cmd
+2019-01-05 10:53:42.145931: I tensorflow/core/platform/cpu_feature_guard.cc:141] Your CPU supports instructions that this TensorFlow binary was not compiled to use: AVX2
+Hello, TensorFlow!
+Press any key to continue . . .
+```
+
diff --git a/docs/source/_static/front-cover.jpg b/docs/source/_static/front-cover.jpg
diff --git a/docs/source/_static/new-project-console.png b/docs/source/_static/new-project-console.png
diff --git a/docs/source/_static/new-project.png b/docs/source/_static/new-project.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -25,4 +25,5 @@ Indices and tables
    :maxdepth: 3
    :caption: Get Started with TensorFlow.NET:
 
-   FrontCover
+   FrontCover
+   HelloWorld
diff --git a/test/TensorFlowNET.Examples/HelloWorld.cs b/test/TensorFlowNET.Examples/HelloWorld.cs
@@ -13,18 +13,20 @@ public class HelloWorld : IExample
     {
         public void Run()
         {
-            /* # Create a Constant op
-              The op is added as a node to the default graph.
+            /* Create a Constant op
+               The op is added as a node to the default graph.
             
-              The value returned by the constructor represents the output
-              of the Constant op.*/
+               The value returned by the constructor represents the output
+               of the Constant op. */
             var hello = tf.constant("Hello, TensorFlow!");
 
             // Start tf session
-            var sess = tf.Session();
-
-            // Run the op
-            Console.WriteLine(sess.run(hello));
+            using (var sess = tf.Session())
+            {
+                // Run the op
+                var result = sess.run(hello);
+                Console.WriteLine(result);
+            }
         }
     }
 }
diff --git a/test/TensorFlowNET.Examples/Program.cs b/test/TensorFlowNET.Examples/Program.cs
@@ -20,11 +20,8 @@ static void Main(string[] args)
                 catch (Exception ex)
                 {
                     Console.WriteLine(ex);
-                    Console.ReadLine();
                 }
             }
-
-            Console.ReadLine();
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -13,18 +13,20 @@ public class HelloWorld : IExample`
`13`	`13`	`{`
`14`	`14`	`public void Run()`
`15`	`15`	`{`
`16`		`- /* # Create a Constant op`
`17`		`- The op is added as a node to the default graph.`
	`16`	`+ /* Create a Constant op`
	`17`	`+ The op is added as a node to the default graph.`
`18`	`18`
`19`		`- The value returned by the constructor represents the output`
`20`		`- of the Constant op.*/`
	`19`	`+ The value returned by the constructor represents the output`
	`20`	`+ of the Constant op. */`
`21`	`21`	`var hello = tf.constant("Hello, TensorFlow!");`
`22`	`22`
`23`	`23`	`// Start tf session`
`24`		`- var sess = tf.Session();`
`25`		`-`
`26`		`- // Run the op`
`27`		`- Console.WriteLine(sess.run(hello));`
	`24`	`+ using (var sess = tf.Session())`
	`25`	`+ {`
	`26`	`+ // Run the op`
	`27`	`+ var result = sess.run(hello);`
	`28`	`+ Console.WriteLine(result);`
	`29`	`+ }`
`28`	`30`	`}`
`29`	`31`	`}`
`30`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,11 +20,8 @@ static void Main(string[] args)`
`20`	`20`	`catch (Exception ex)`
`21`	`21`	`{`
`22`	`22`	`Console.WriteLine(ex);`
`23`		`- Console.ReadLine();`
`24`	`23`	`}`
`25`	`24`	`}`
`26`		`-`
`27`		`- Console.ReadLine();`
`28`	`25`	`}`
`29`	`26`	`}`
`30`	`27`	`}`