Skip to content
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.

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

Doc of paddle.save/load #32900

Merged
merged 2 commits into from
May 14, 2021
Merged
Changes from all commits
Commits
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
61 changes: 55 additions & 6 deletions python/paddle/framework/io.py
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ def save(obj, path, protocol=2, **configs):
Save an object to the specified path.

.. note::
Now supports saving ``state_dict`` of Layer/Optimizer, Layer, Tensor and nested structure containing Tensor.
Now supports saving ``state_dict`` of Layer/Optimizer, Layer, Tensor and nested structure containing Tensor, Program.

.. note::
Different from ``paddle.jit.save``, since the save result of ``paddle.save`` is a single file,
Expand Down Expand Up @@ -544,7 +544,18 @@ def save(obj, path, protocol=2, **configs):
# save weight of emb
paddle.save(emb.weight, "emb.weight.pdtensor")

# example 2: static graph
# example 2: Save multiple state_dict at the same time
from paddle import nn
from paddle.optimizer import Adam

layer = paddle.nn.Linear(3, 4)
adam = Adam(learning_rate=0.001, parameters=layer.parameters())
obj = {'model': layer.state_dict(), 'opt': adam.state_dict(), 'epoch': 100}
path = 'example/model.pdparams'
paddle.save(obj, path)


# example 3: static graph
import paddle
import paddle.static as static

Expand All @@ -570,6 +581,18 @@ def save(obj, path, protocol=2, **configs):
# save/load state_dict
path_state_dict = 'temp/model.pdparams'
paddle.save(prog.state_dict("param"), path_tensor)

# example 4: save program
import paddle

paddle.enable_static()

data = paddle.static.data(
name='x_static_save', shape=(None, 224), dtype='float32')
y_static = z = paddle.static.nn.fc(data, 10)
main_program = paddle.static.default_main_program()
path = "example/main_program.pdmodel"
paddle.save(main_program, path)
'''
# 1. input check
filename = os.path.basename(path)
Expand Down Expand Up @@ -667,7 +690,7 @@ def load(path, **configs):
Load an object can be used in paddle from specified path.

.. note::
Now supports loading ``state_dict`` of Layer/Optimizer, Layer, Tensor and nested structure containing Tensor.
Now supports loading ``state_dict`` of Layer/Optimizer, Layer, Tensor and nested structure containing Tensor, Program.

.. note::
In order to use the model parameters saved by paddle more efficiently,
Expand Down Expand Up @@ -714,8 +737,6 @@ def load(path, **configs):
Examples:
.. code-block:: python

import paddle

# example 1: dynamic graph
import paddle
emb = paddle.nn.Embedding(10, 10)
Expand Down Expand Up @@ -744,7 +765,19 @@ def load(path, **configs):
load_weight = paddle.load("emb.weight.pdtensor")


# example 2: static graph
# example 2: Load multiple state_dict at the same time
from paddle import nn
from paddle.optimizer import Adam

layer = paddle.nn.Linear(3, 4)
adam = Adam(learning_rate=0.001, parameters=layer.parameters())
obj = {'model': layer.state_dict(), 'opt': adam.state_dict(), 'epoch': 100}
path = 'example/model.pdparams'
paddle.save(obj, path)
obj_load = paddle.load(path)


# example 3: static graph
import paddle
import paddle.static as static

Expand Down Expand Up @@ -773,6 +806,22 @@ def load(path, **configs):
paddle.save(prog.state_dict("param"), path_tensor)
load_state_dict = paddle.load(path_tensor)


# example 4: load program
import paddle

paddle.enable_static()

data = paddle.static.data(
name='x_static_save', shape=(None, 224), dtype='float32')
y_static = z = paddle.static.nn.fc(data, 10)
main_program = paddle.static.default_main_program()
path = "example/main_program.pdmodel"
paddle.save(main_program, path)
load_main = paddle.load(path)
print(load_main)


'''

if os.path.isfile(path):
Expand Down