Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into fix_dead_link

8 years ago · 57bac90cb5
parent dab81d4d03 56c20f8261
commit 57bac90cb5
43 changed files with 65 additions and 1372 deletions
--- a/.travis.yml
+++ b/.travis.yml
@ -50,7 +50,7 @@ before_install:
    fi
  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo paddle/scripts/travis/before_install.linux.sh; fi
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then paddle/scripts/travis/before_install.osx.sh; fi
-  - pip install wheel protobuf sphinx breathe recommonmark virtualenv numpy sphinx_rtd_theme
+  - pip install wheel protobuf sphinx recommonmark virtualenv numpy sphinx_rtd_theme
 script:
  - paddle/scripts/travis/main.sh
 notifications:
--- a/cmake/check_packages.cmake
+++ b/cmake/check_packages.cmake
@ -30,7 +30,6 @@ if(WITH_DOC)
  find_package(Sphinx REQUIRED)
  find_package(Doxygen REQUIRED)
  find_python_module(recommonmark REQUIRED)
-  find_python_module(breathe REQUIRED)
 endif()

 if(WITH_SWIG_PY)
--- a/doc/getstarted/build_and_install/build_from_source_en.md
+++ b/doc/getstarted/build_and_install/build_from_source_en.md
@ -79,7 +79,7 @@ As a simple example, consider the following:

    ```bash
    pip install 'sphinx>=1.4.0'
-    pip install sphinx_rtd_theme breathe recommonmark
+    pip install sphinx_rtd_theme recommonmark

    # install doxygen on Ubuntu
    sudo apt-get install doxygen 
--- a/doc/howto/source/api.rst
+++ b/doc/howto/source/api.rst
@ -1,5 +0,0 @@
-API
-===
-
-.. doxygenfile:: paddle/api/PaddleAPI.h
-.. doxygenfile:: paddle/api/Internal.h
--- a/doc/howto/source/cuda/index.rst
+++ b/doc/howto/source/cuda/index.rst
@ -1,9 +0,0 @@
-CUDA
-====
-
-.. toctree::
-  :maxdepth: 2
-
-  matrix.rst
-  nn.rst
-  utils.rst
--- a/doc/howto/source/cuda/matrix.rst
+++ b/doc/howto/source/cuda/matrix.rst
@ -1,59 +0,0 @@
-Matrix
-======
-
-Base
----
-
-hl_matrix.h
-```````````
-.. doxygenfile:: paddle/cuda/include/hl_matrix.h
-
-hl_matrix_base.h
-````````````````
-.. doxygenfile:: paddle/cuda/include/hl_matrix_base.cuh
-
-hl_matrix_apply.cuh
-```````````````````
-.. doxygenfile:: paddle/cuda/include/hl_matrix_apply.cuh
-
-hl_matrix_ops.cuh
-`````````````````
-.. doxygenfile:: paddle/cuda/include/hl_matrix_ops.cuh
-
-hl_matrix_type.cuh
-``````````````````
-.. doxygenfile:: paddle/cuda/include/hl_matrix_type.cuh
-
-hl_sse_matrix_kernel.cuh
-````````````````````````
-.. doxygenfile:: paddle/cuda/include/hl_sse_matrix_kernel.cuh
-
-Matrix Function 
---------------
-
-hl_batch_transpose.h
-````````````````````
-.. doxygenfile:: paddle/cuda/include/hl_batch_transpose.h
-
-hl_aggregate.h
-``````````````
-.. doxygenfile:: paddle/cuda/include/hl_aggregate.h
-
-hl_top_k.h
-``````````
-.. doxygenfile:: paddle/cuda/include/hl_top_k.h
-
-hl_table_apply.h
-````````````````
-.. doxygenfile:: paddle/cuda/include/hl_table_apply.h
-
-Sparse Matrix
-------------
-
-hl_sparse.h
-```````````
-.. doxygenfile:: paddle/cuda/include/hl_sparse.h
-
-hl_sparse.ph
-````````````
-.. doxygenfile:: paddle/cuda/include/hl_sparse.ph
--- a/doc/howto/source/cuda/nn.rst
+++ b/doc/howto/source/cuda/nn.rst
@ -1,39 +0,0 @@
-Neural Network
-==============
-
-Base
----
-
-.. doxygenfile:: paddle/cuda/include/hl_gpu.h
-.. doxygenfile:: paddle/cuda/include/hl_functions.h
-.. doxygenfile:: paddle/cuda/include/hl_avx_functions.h
-.. doxygenfile:: paddle/cuda/include/hl_gpu_functions.cuh
-.. doxygenfile:: paddle/cuda/include/hl_activation_functions.h
-
-
-CNN Related APIs
----------------
-.. doxygenfile:: paddle/cuda/include/hl_cnn.h
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.h
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cudnn.ph
-
-RNN Related APIs
----------------
-
-.. doxygenfile:: paddle/cuda/include/hl_recurrent_apply.cuh
-.. doxygenfile:: paddle/cuda/include/hl_sequence.h
-
-LSTM Model
-``````````
-
-.. doxygenfile:: paddle/cuda/include/hl_lstm.h
-.. dpxygenfile:: paddle/cuda/include/hl_cpu_lstm.cuh
-.. doxygenfile:: paddle/cuda/include/hl_gpu_lstm.cuh
-.. doxygenfile:: paddle/cuda/include/hl_lstm_ops.cuh
-
-GRU Model
-`````````
-
-.. doxygenfile:: paddle/cuda/include/hl_gru_ops.cuh
-.. doxygenfile:: paddle/cuda/include/hl_cpu_gru.cuh
-.. doxygenfile:: paddle/cuda/include/hl_gpu_gru.cuh
--- a/doc/howto/source/cuda/utils.rst
+++ b/doc/howto/source/cuda/utils.rst
@ -1,37 +0,0 @@
-Utils
-=====
-
-Dynamic Link Libs
-----------------
-.. doxygenfile:: paddle/cuda/include/hl_dso_loader.h
-
-GPU Resources
-------------
-
-hl_cuda.ph
-``````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda.ph
-
-hl_cuda.h
-`````````
-.. doxygenfile:: paddle/cuda/include/hl_cuda.h
-
-HPPL Base
---------
-.. doxygenfile:: paddle/cuda/include/hl_base.h
-
-CUBLAS Wrapper
--------------
-.. doxygenfile:: paddle/cuda/include/hl_cuda_cublas.h
-
-Timer
-----
-.. doxygenfile:: paddle/cuda/include/hl_time.h
-
-Thread Resource
---------------
-.. doxygenfile:: paddle/cuda/include/hl_thread.ph
-
-Device Function
---------------
-.. doxygenfile:: paddle/cuda/include/hl_device_functions.cuh
--- a/doc/howto/source/gserver/activations.rst
+++ b/doc/howto/source/gserver/activations.rst
@ -1,5 +0,0 @@
-Activations
-===========
-
-..  doxygenclass:: paddle::ActivationFunction
-    :members:
--- a/doc/howto/source/gserver/dataproviders.rst
+++ b/doc/howto/source/gserver/dataproviders.rst
@ -1,87 +0,0 @@
-==============
-Data Providers
-==============
-
-DataProviders
-=============
-
-Base
----
-..  doxygenclass:: paddle::DataProvider
-    :members:
-
-DataProviderGroup
-----------------
-..  doxygenclass:: paddle::DataProviderGroup
-    :members:
-
-MultiDataProvider
-----------------
-..  doxygenclass:: paddle::MultiDataProvider
-    :members:
-
-PyDataProvider
-==============
-
-IFieldScanner
-------------
-..  doxygenclass:: paddle::IFieldScanner
-    :members:
-
-DenseScanner
-------------
-..  doxygenclass:: paddle::DenseScanner
-    :members:
-
-IndexScanner
-------------
-..  doxygenclass:: paddle::IndexScanner
-    :members:
-
-SparseNonValueScanner
---------------------
-..  doxygenclass:: paddle::SparseNonValueScanner
-    :members:
-
-SparseValueScanner
------------------
-..  doxygenclass:: paddle::SparseValueScanner
-    :members:
-
-SequenceScanner
---------------
-..  doxygenclass:: paddle::SparseValueScanner
-    :members:
-
-IPyDataProviderCache
--------------------
-..  doxygenclass:: paddle::IPyDataProviderCache
-    :members:
-
-NoCacheStrategy
---------------
-..  doxygenclass:: paddle::NoCacheStrategy
-    :members:
-
-CacheOnePassInMemory
--------------------
-..  doxygenclass:: paddle::CacheOnePassInMemory
-    :members:
-
-IPyDataProvider
---------------
-..  doxygenclass:: paddle::PyDataProvider2
-    :members:
-
-ProtoDataProvider
-=================
-
-ProtoDataProvider
----------------
-..  doxygenclass:: paddle::ProtoDataProvider
-    :members:
-
-ProtoSequenceDataProvider
-------------------------
-..  doxygenclass:: paddle::ProtoSequenceDataProvider
-    :members:
--- a/doc/howto/source/gserver/evaluators.rst
+++ b/doc/howto/source/gserver/evaluators.rst
@ -1,103 +0,0 @@
-==========
-Evaluators
-==========
-
-Base
-====
-
-..  doxygenclass:: paddle::Evaluator
-    :members:
-
-Sum
-===
-
-SumEvaluator
------------
-..  doxygenclass:: paddle::SumEvaluator
-    :members:
-
-ColumnSumEvaluator
------------------
-..  doxygenclass:: paddle::ColumnSumEvaluator
-    :members:
-
-Classification
-==============
-
-ClassificationErrorEvaluator
---------------------------
-..  doxygenclass:: paddle::ClassificationErrorEvaluator
-    :members:
-
-SequenceClassificationErrorEvaluator
------------------------------------
-..  doxygenclass:: paddle::SequenceClassificationErrorEvaluator
-    :members:
-
-AucEvaluator
-------------
-..  doxygenclass:: paddle::AucEvaluator
-    :members:
-
-PrecisionRecallEvaluator
------------------------
-..  doxygenclass:: paddle::PrecisionRecallEvaluator
-    :members:
-
-ChunkEvaluator
--------------
-..  doxygenclass:: paddle::ChunkEvaluator
-    :members:
-
-CTCEvaluator
------------
-..  doxygenclass:: paddle::CTCErrorEvaluator
-    :members:
-
-
-Rank
-====
-
-PnpairEvaluator
-------------
-..  doxygenclass:: paddle::PnpairEvaluator
-    :members:
-
-AucEvaluator
-------------
-..  doxygenclass:: paddle::RankAucEvaluator
-    :members:
-
-
-Printer
-=======
-
-ValuePrinter
-------------
-..  doxygenclass:: paddle::ValuePrinter
-    :members:
-
-GradientPrinter
---------------
-..  doxygenclass:: paddle::GradientPrinter
-    :members:
-
-MaxIdPrinter
------------
-..  doxygenclass:: paddle::MaxIdPrinter
-    :members:
-
-MaxFramePrinter
---------------
-..  doxygenclass:: paddle::MaxFramePrinter
-    :members:
-
-SequenceTextPrinter
------------------
-..  doxygenclass:: paddle::SequenceTextPrinter
-    :members:
-
-ClassificationErrorPrinter
--------------------------
-..  doxygenclass:: paddle::ClassificationErrorPrinter
-    :members:
--- a/doc/howto/source/gserver/gradientmachines.rst
+++ b/doc/howto/source/gserver/gradientmachines.rst
@ -1,27 +0,0 @@
-Gradient Machines
-=================
-
-GradientMachine
---------------
-..  doxygenclass:: paddle::GradientMachine
-    :members:
-
-GradientMachineMode
-------------------
-..  doxygenclass:: paddle::IGradientMachineMode
-    :members:
-
-MultiGradientMachine
--------------------
-..  doxygenclass:: paddle::MultiGradientMachine
-    :members:
-
-TrainerThread
-`````````````
-..  doxygenclass:: paddle::TrainerThread
-    :members:
-
-RecurrentGradientMachine
------------------------
-..  doxygenclass:: paddle::RecurrentGradientMachine
-    :members:
--- a/doc/howto/source/gserver/index.rst
+++ b/doc/howto/source/gserver/index.rst
@ -1,12 +0,0 @@
-GServer
-=======
-
-.. toctree::
-  :maxdepth: 2
-
-  activations.rst
-  dataproviders.rst
-  evaluators.rst
-  gradientmachines.rst
-  layers.rst
-  neworks.rst
--- a/doc/howto/source/gserver/layers.rst
+++ b/doc/howto/source/gserver/layers.rst
--- a/doc/howto/source/gserver/neworks.rst
+++ b/doc/howto/source/gserver/neworks.rst
@ -1,12 +0,0 @@
-Networks
-========
-
-NeuralNetwork
-------------
-..  doxygenclass:: paddle::NeuralNetwork
-    :members:
-
-ParallelNeuralNetwork
---------------------
-..  doxygenclass:: paddle::ParallelNeuralNetwork
-    :members:
--- a/doc/howto/source/index.rst
+++ b/doc/howto/source/index.rst
@ -1,14 +0,0 @@
-Source Code Documents
-=====================
-
-.. toctree::
-  :maxdepth: 1
-
-  gserver/index.rst
-  trainer.rst
-  parameter/index.rst
-  pserver/index.rst
-  api.rst
-  cuda/index.rst
-  math/index.rst
-  utils/index.rst
--- a/doc/howto/source/math/functions.rst
+++ b/doc/howto/source/math/functions.rst
@ -1,10 +0,0 @@
-Functions
-=========
-
-MathFunctions
-------------
-.. doxygenfile:: paddle/math/MathFunctions.h
-
-SIMDFunctions
-------------
-.. doxygenfile:: paddle/math/SIMDFunctions.h
--- a/doc/howto/source/math/index.rst
+++ b/doc/howto/source/math/index.rst
@ -1,10 +0,0 @@
-Math
-====
-
-.. toctree::
-  :maxdepth: 2
-
-  vector.rst
-  matrix.rst
-  functions.rst
-  utils.rst
--- a/doc/howto/source/math/matrix.rst
+++ b/doc/howto/source/math/matrix.rst
@ -1,76 +0,0 @@
-Matrix
-======
-
-Base
----
-
-BaseMatrix Template
-```````````````````
-..  doxygenclass:: paddle::BaseMatrixT
-    :members:
-
-Matrix
-``````
-..  doxygenclass:: paddle::Matrix
-    :members:
-
-MatrixOffset
-````````````
-..  doxygenclass:: paddle::MatrixOffset
-    :members:
-
-CpuMatrix
---------
-
-CpuMatrix
-`````````
-..  doxygenclass:: paddle::CpuMatrix
-    :members:
-
-SharedCpuMatrix
-```````````````
-..  doxygenclass:: paddle::SharedCpuMatrix
-    :members:
-
-GpuMatrix
---------
-..  doxygenclass:: paddle::GpuMatrix
-    :members:
-
-CpuSparseMatrix
---------------
-
-CpuSparseMatrix
-```````````````
-..  doxygenclass:: paddle::CpuSparseMatrix
-    :members:
-
-SparseRowCpuMatrix
-``````````````````
-..  doxygenclass:: paddle::SparseRowCpuMatrix
-    :members:
-
-SparseAutoGrowRowCpuMatrix
-``````````````````````````
-..  doxygenclass:: paddle::SparseAutoGrowRowCpuMatrix
-    :members:
-
-SparsePrefetchRowCpuMatrix
-``````````````````````````
-..  doxygenclass:: paddle::SparsePrefetchRowCpuMatrix
-    :members:
-
-SparseRowIdsCpuMatrix
-`````````````````````
-..  doxygenclass:: paddle::SparseRowIdsCpuMatrix
-    :members:
-
-CacheRowCpuMatrix
-`````````````````
-..  doxygenclass:: paddle::CacheRowCpuMatrix
-    :members:
-
-GpuSparseMatrix
---------------
-..  doxygenclass:: paddle::GpuSparseMatrix
-    :members:
--- a/doc/howto/source/math/utils.rst
+++ b/doc/howto/source/math/utils.rst
@ -1,18 +0,0 @@
-Memory Manager
-==============
-
-Memory Handle
-------------
-.. doxygenfile:: paddle/math/MemoryHandle.h
-
-Allocator
---------
-.. doxygenfile:: paddle/math/Allocator.h
-
-PoolAllocator
-`````````````
-.. doxygenfile:: paddle/math/PoolAllocator.h
-
-Storage
-------
-.. doxygenfile:: paddle/math/Storage.h
--- a/doc/howto/source/math/vector.rst
+++ b/doc/howto/source/math/vector.rst
@ -1,37 +0,0 @@
-Vector
-======
-
-BaseVector
-``````````
-..  doxygenclass:: paddle::BaseVector
-    :members:
-
-Vector Template
-```````````````
-..  doxygenclass:: paddle::VectorT
-    :members:
-
-CpuVector Template
-``````````````````
-..  doxygenclass:: paddle::CpuVectorT
-    :members:
-
-GpuVector Template
-``````````````````
-..  doxygenclass:: paddle::GpuVectorT
-    :members:
-
-ParallelCpuVector Template
-``````````````````````````
-..  doxygenclass:: paddle::ParallelCpuVectorT
-    :members:
-
-ParallelGpuVector Template
-``````````````````````````
-..  doxygenclass:: paddle::ParallelGpuVectorT
-    :members:
-
-CpuGpuVector Template
-`````````````````````
-..  doxygenclass:: paddle::CpuGpuVectorT
-    :members:
--- a/doc/howto/source/parameter/index.rst
+++ b/doc/howto/source/parameter/index.rst
@ -1,9 +0,0 @@
-Parameter
-=========
-
-.. toctree::
-  :maxdepth: 2
-
-  parameter.rst
-  optimizer.rst
-  updater.rst
--- a/doc/howto/source/parameter/optimizer.rst
+++ b/doc/howto/source/parameter/optimizer.rst
@ -1,22 +0,0 @@
-Optimizer
-=========
-
-ParameterOptimizer
------------------
-.. doxygenfile:: paddle/parameter/ParameterOptimizer.h
-
-Regularizer
-----------
-.. doxygenfile:: paddle/parameter/Regularizer.h
-
-FirstOrderOptimizer
-------------------
-.. doxygenfile:: paddle/parameter/FirstOrderOptimizer.h
-
-AverageOptimizer
----------------
-.. doxygenfile:: paddle/parameter/AverageOptimizer.h
-
-OptimizerWithRegularizer
------------------------
-.. doxygenfile:: paddle/parameter/OptimizerWithRegularizer.h
--- a/doc/howto/source/parameter/parameter.rst
+++ b/doc/howto/source/parameter/parameter.rst
@ -1,12 +0,0 @@
-Parameter
-=========
-
-Parameter
---------
-.. doxygenfile:: paddle/parameter/Argument.h
-.. doxygenfile:: paddle/parameter/Parameter.h
-.. doxygenfile:: paddle/parameter/ParallelParameter.h
-
-Weight
------
-.. doxygenfile:: paddle/parameter/Weight.h
--- a/doc/howto/source/parameter/updater.rst
+++ b/doc/howto/source/parameter/updater.rst
@ -1,14 +0,0 @@
-Updater
-=======
-
-Base
----
-.. doxygenfile:: paddle/parameter/ParameterUpdaterBase.h
-
-Hook
----
-.. doxygenfile:: paddle/parameter/ParameterUpdaterHook.h
-
-Functions
---------
-.. doxygenfile:: paddle/parameter/ParameterUpdateFunctions.h
--- a/Show More
+++ b/Show More