Skip to content

fix doc in transpiler #17313

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.

Sign up for GitHub

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

Merged
seiriosPlus merged 8 commits into from
May 29, 2019
Merged

fix doc in transpiler #17313

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dc98098
fix doc in transpiler, test=develop
seiriosPlus May 9, 2019
af479a2
fix doc in memory transpiler, test=develop
seiriosPlus May 9, 2019
f054769
fix doc
seiriosPlus May 24, 2019
7276e03
fix doc in memory optimization, test=develop
seiriosPlus May 24, 2019
fef707b
fix doc in memory optimization, test=develop
seiriosPlus May 27, 2019
4f7ab7e
Merge branch 'develop' of github.com:PaddlePaddle/Paddle into fix/doc…
seiriosPlus May 28, 2019
f66ad2e
Merge branch 'develop' of github.com:PaddlePaddle/Paddle into fix/doc…
seiriosPlus May 29, 2019
5041fe0
fix api.spce, test=develop
seiriosPlus May 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions python/paddle/fluid/transpiler/memory_optimization_transpiler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,17 @@ def memory_optimize(input_program,
level(int): If level=0, reuse if the shape is completely equal, o
Returns:
None

Examples:
.. code-block:: python
Copy link
Copy Markdown
Collaborator

@shanyi15 shanyi15 May 24, 2019

Choose a reason for hiding this comment

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

  1. .. code-block:: python和下面代码部分之间需要空一行，下同
  2. 请加上必要的import，例如import paddle.fluid as fluid

main_prog = fluid.Program()
startup_prog = fluid.Program()

place = fluid.CPUPlace()
exe = fluid.Executor(place)

exe.run(startup_prog)
fluid.memory_optimize(main_prog)
"""
sys.stderr.write('memory_optimize is deprecated. '
'Use CompiledProgram and Executor\n')
Expand Down Expand Up @@ -565,6 +576,17 @@ def release_memory(input_program, skip_opt_set=None):
skip_opt_set(set): vars wil be skipped in memory optimze
Returns:
None

Examples:
.. code-block:: python
main_prog = fluid.Program()
startup_prog = fluid.Program()

place = fluid.CPUPlace()
exe = fluid.Executor(place)

exe.run(startup_prog)
fluid.release_memory(main_prog)
"""
cfgs = _get_cfgs(input_program)
input_program._is_mem_optimized = True
Expand Down
16 changes: 16 additions & 0 deletions python/paddle/fluid/transpiler/ps_dispatcher.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ class HashName(PSDispatcher):

Args:
pserver_endpoints (list): list of endpoint(ip:port).

Examples:
.. code-block:: python
pserver_endpoints = ["127.0.0.1:6007", "127.0.0.1:6008"]
vars = ["var1","var2","var3","var4","var5"]

rr = RoundRobin(pserver_endpoints)
rr.dispatch(vars)
"""

def __init__(self, pserver_endpoints):
Expand All @@ -74,6 +82,14 @@ class RoundRobin(PSDispatcher):

Args:
pserver_endpoints (list): list of endpoint(ip:port).

Examples:
.. code-block:: python
pserver_endpoints = ["127.0.0.1:6007", "127.0.0.1:6008"]
vars = ["var1","var2","var3","var4","var5"]

rr = RoundRobin(pserver_endpoints)
rr.dispatch(vars)
"""

def __init__(self, pserver_endpoints):
Expand Down