Skip to content

Commit 1956cf9

Browse files
committed
build docs in Sphinx.
1 parent 3615dba commit 1956cf9

20 files changed

Lines changed: 299 additions & 5 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -334,3 +334,4 @@ ASALocalRun/
334334
/tensorflowlib/linux/native/libtensorflow_framework.so
335335
/tensorflowlib/linux/native/libtensorflow.so
336336
/src/TensorFlowNET.Core/tensorflow.dll
337+
/docs/build

docs/Makefile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = source
8+
BUILDDIR = build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/assets/Cover.psd

338 KB
Binary file not shown.

docs/make.bat

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
set SOURCEDIR=source
11+
set BUILDDIR=build
12+
13+
if "%1" == "" goto help
14+
15+
%SPHINXBUILD% >NUL 2>NUL
16+
if errorlevel 9009 (
17+
echo.
18+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19+
echo.installed, then set the SPHINXBUILD environment variable to point
20+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21+
echo.may add the Sphinx directory to PATH.
22+
echo.
23+
echo.If you don't have Sphinx installed, grab it from
24+
echo.http://sphinx-doc.org/
25+
exit /b 1
26+
)
27+
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
29+
goto end
30+
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
33+
34+
:end
35+
popd
File renamed without changes.
File renamed without changes.
Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,24 @@
44

55

66

7-
### The CSharp binding for Google's TensorFlow - An Open Source Machine Learning Framework for Everyone
8-
### 谷歌TensorFlow的C#封装库,开源机器学习框架。
7+
8+
9+
10+
11+
12+
![column-major order](_static/cover.jpg)
13+
14+
15+
16+
17+
18+
### The CSharp binding for Google's TensorFlow
19+
20+
#### An Open Source Machine Learning Framework for Everyone
21+
22+
### 谷歌TensorFlow的C#封装库
23+
24+
#### 开源机器学习框架。
925

1026

1127

docs/The-Definitive-Guide/CH_3 Operation.md renamed to docs/source/Graph.md

File renamed without changes.

docs/source/HelloWorld.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Get started with TensorFlow.NET
2+
3+
让我们先运行一个经典的HelloWorld程序,看看TensorFlow是在.NET上面运行的效果,我想不出有比做个HelloWorld再简单的方式了。
4+
5+
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.
6+
7+
### Install the TensorFlow.NET SDK
8+
9+
To start building TensorFlow program you just need to download and install the .NET SDK (Software Development Kit).
10+
11+
```cmd
12+
PM> Install-Package TensorFlow.NET
13+
```
14+
File renamed without changes.

0 commit comments

Comments
 (0)