提交 69ab9ec6 编写于 作者: G guru4elephant

initial commit for paddle fl

上级 7876529c
| Github account | name |
|---|---|
| guru4elephant | Daxiang Dong |
\ No newline at end of file
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = src
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
此差异已折叠。
sphinx==2.1.0
mistune
crate-docs-theme
paddle_fl
===
.. toctree::
:maxdepth: 1
paddle_fl
paddle_fl.common module: Paddle FL Common Functions
===============================
.. automodule:: paddle_fl.common.rst
:members:
:undoc-members:
:show-inheritance:
paddle_fl.core.master module: Paddle FL master
===============================
.. automodule:: paddle_fl.core.master
:members:
:undoc-members:
:show-inheritance:
paddle_fl.core.server module: Paddle FL Server
===============================
.. automodule:: paddle_fl.core.server.rst
:members:
:undoc-members:
:show-inheritance:
paddle_fl.core.trainer module: Paddle FL Trainer
===============================
.. automodule:: paddle_fl.core.trainer.rst
:members:
:undoc-members:
:show-inheritance:
paddle_fl.dataset module: Paddle FL Dataset
===============================
.. automodule:: paddle_fl.dataset.rst
:members:
:undoc-members:
:show-inheritance:
paddle_fl.reader module: Paddle FL Reader
===============================
.. automodule:: paddle_fl.reader.rst
:members:
:undoc-members:
:show-inheritance:
# Copyright (c) 2019 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
"""
conf.py
"""
import os
import sys
sys.path.append(os.path.abspath('../../paddle_fl/'))
sys.path.append(os.path.abspath('..'))
#import crate_docs_theme
# -- Project information -----------------------------------------------------
project = 'paddle_fl'
copyright = '2019, PaddlePaddle'
author = 'PaddlePaddle'
# The full version, including alpha/beta/rc tags
release = '0.1.0.beta'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.todo', 'sphinx.ext.viewcode', 'sphinx.ext.mathjax',
'sphinx.ext.autodoc', 'sphinx.ext.napoleon', "markdown2rst"
]
# Support Inline mathjax
m2r_disable_inline_math = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
source_suffix = ['.rst', '.md']
#exclude_patterns = ['pgl.graph_kernel', 'pgl.layers.conv']
lanaguage = "zh_cn"
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
#html_theme = "sphinx_rtd_theme"
#html_theme = "crate-docs-theme"
#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
html_show_sourcelink = False
#html_logo = 'pgl_logo.png'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
'''
html_theme_options = {
'canonical_url': '',
'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
'''
:github_url: https://github.com/PaddlePaddle/PaddleFL
.. toctree::
:maxdepth: 1
:caption: Introduction
:hidden:
introduction.rst
.. mdinclude:: markdown/introduction.md
Quick Start
===========
.. toctree::
:maxdepth: 1
:caption: Quick Start
:hidden:
instruction.rst
See instruction_ for quick start.
.. _instruction: instruction.html
.. toctree::
:maxdepth: 1
:caption: Examples
examples/ctr_examples.rst
.. toctree::
:maxdepth: 2
:caption: API Reference
api/paddle_fl
The Team
========
.. toctree::
:maxdepth: 1
:caption: The Team
:hidden:
team.rst
PaddleFL is developed and maintained by Nimitz
License
=======
PaddleFL uses Apache License 2.0.
Quick Start Instructions
========================
Install PaddleFL
-----------
To install Paddle Federated Learning, we need the following packages.
.. code-block:: sh
paddlepaddle >= 1.6 (Faster performance on 1.6)
networkx
cython
We can simply install PaddleFL by pip.
.. code-block:: sh
pip install paddle_fl
.. mdinclude:: markdown/quick_start.md
The Team
========
PaddleFL is developed and maintained by Nimitz
# Copyright (c) 2019 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Setup for pip package."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
import platform
from setuptools import find_packages
from setuptools import setup
from paddle_fl.version import fl_version
def python_version():
return [int(v) for v in platform.python_version().split(".")]
max_version, mid_version, min_version = python_version()
REQUIRED_PACKAGES = [
'six >= 1.10.0', 'protobuf >= 3.1.0',
]
if max_version < 3:
REQUIRED_PACKAGES += ["enum"]
else:
REQUIRED_PACKAGES += ["numpy"]
setup(
name='paddle_fl',
version=fl_version.replace('-', ''),
description=
('Federated Deep Learning Package Based on PaddlePaddle.'),
long_description='',
url='https://github.com/PaddlePaddle/PaddleFL',
author='PaddlePaddle Author',
author_email='paddle-dev@baidu.com',
install_requires=REQUIRED_PACKAGES,
packages=find_packages(),
# PyPI package information.
classifiers=[
'Development Status :: 4 - Beta',
'Intended Audience :: Developers',
'Intended Audience :: Education',
'Intended Audience :: Science/Research',
'License :: OSI Approved :: Apache Software License',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3.6',
'Topic :: Scientific/Engineering',
'Topic :: Scientific/Engineering :: Mathematics',
'Topic :: Scientific/Engineering :: Artificial Intelligence',
'Topic :: Software Development',
'Topic :: Software Development :: Libraries',
'Topic :: Software Development :: Libraries :: Python Modules',
],
license='Apache 2.0',
keywords=('paddle_fl paddlepaddle multi-task transfer distributed-training'))
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册