fluid

SourceEnglish

AsyncExecutor

SourceEnglish

class paddle.fluid.AsyncExecutor(place=None)

参数：

- place (fluid.CPUPlace|None) - 指示 executor 将在哪个设备上运行。目前仅支持CPU

datafeed = fluid.DataFeedDesc('data.proto')
startup_program = fluid.default_startup_program()
main_program = fluid.default_main_program()
filelist = ["train_data/part-%d" % i for i in range(100)]
thread_num = len(filelist) / 4
place = fluid.CPUPlace()
async_executor = fluid.AsyncExecutor(place)
async_executor.run_startup_program(startup_program)
epoch = 10
for i in range(epoch):
    async_executor.run(main_program,
                       data_feed,
                       filelist,
                       thread_num,
                       [acc],
                       debug=False)

run(_program, data_feed, filelist, thread_num, fetch, debug=False)

参数:

- program (Program) – 需要执行的program。如果没有提供该参数，默认使用 defaultmain_program
- data_feed (DataFeedDesc) – DataFeedDesc 对象
- filelist (str) – 一个包含训练数据集文件的文件列表
- thread_num (int) – 并发训练线程数。参照 注解_ 部分获取合适的设置方法
- fetch (str|list) – 变量名，或者变量名列表。指明最后要进行观察的变量命名
- debug (bool) – 如果为True, 在每一个minibatch处理后，fetch 中指明的变量将会通过标准输出打印出来

注解

1.该执行器会运行program中的所有运算，不只是那些依赖于fetchlist的运算

2.该类执行器在多线程上运行，每个线程占用一个CPU核。为了实现效率最大化，建议将 thread_num 等于或稍微小于CPU核心数

BuildStrategy

SourceEnglish

class paddle.fluid.BuildStrategy

buildstrategy = fluid.BuildStrategy()
build_strategy.reduce_strategy = fluid.BuildStrategy.ReduceStrategy.Reduce

train_exe = fluid.ParallelExecutor(use_cuda=True,
                                   loss_name=loss.name,
                                   build_strategy=build_strategy)

train_loss, = train_exe.run([loss.name], feed=feed_dict)

reducestrategy

_class paddle.fluid.CompiledProgram(program)

place = fluid.CUDAPlace(0) if usecuda else fluid.CPUPlace()
        exe = fluid.Executor(place)
        exe.run(startup)
        compiled_prog = compiler.CompiledProgram(main).with_data_parallel(
            loss_name=loss.name)
        for i in range(5):
            test_loss, = exe.run(compiled_prog,
                                 feed=feed_dict,
                                 fetch_list=[loss.name])

with_data_parallel(_loss_name=None, build_strategy=None, exec_strategy=None, share_vars_from=None)

参数：

- loss_name （str） - 损失函数名称必须在训练过程中设置。 默认None。
- build_strategy （BuildStrategy） - buildstrategy用于构建图，因此它可以在具有优化拓扑的多个设备/核上运行。 有关更多信息，请参阅 fluid.BuildStrategy 。 默认None。
- exec_strategy （ExecutionStrategy） - exec_strategy用于选择执行图的方式，例如使用多少线程，每次清理临时变量之前进行的迭代次数。 有关更多信息，请参阅 fluid.ExecutionStrategy 。 默认None。
- share_vars_from （CompiledProgram） - 如果有，此CompiledProgram将共享来自share_vars_from的变量。 share_vars_from指定的Program必须由此CompiledProgram之前的Executor运行，以便vars准备就绪。

with_inference_optimize(_config)

参数：

- config - 用于创建预测器的NativeConfig或AnalysisConfig的实例

class paddle.fluid.CPUPlace

create_lod_tensor

SourceEnglish

paddle.fluid.createlod_tensor(_data, recursive_seq_lens, place)

paddle.fluid.create_random_int_lodtensor(_recursive_seq_lens, base_shape, place, low, high)

_class paddle.fluid.CUDAPinnedPlace

CUDAPlace

SourceEnglish

class paddle.fluid.CUDAPlace

DataFeedDesc

SourceEnglish

class paddle.fluid.DataFeedDesc(proto_file)

datafeed = fluid.DataFeedDesc('data.proto')

name: "MultiSlotDataFeed"
batch_size: 2
multi_slot_desc {
    slots {
        name: "words"
        type: "uint64"
        is_dense: false
        is_used: true
    }
    slots {
        name: "label"
        type: "uint64"
        is_dense: false
        is_used: true
    }
}

data_feed.set_batch_size(128)
data_feed.set_dense_slots('wd')  # The slot named 'wd' will be dense
data_feed.set_use_slots('wd')    # The slot named 'wd' will be used

#Finally, the content can be dumped out for debugging purpose:

print(data_feed.desc())

set_batch_size(_batch_size)

参数：

- batchsize：batch size

data_feed = fluid.DataFeedDesc('data.proto')
data_feed.set_batch_size(128)

set_dense_slots(_dense_slots_name)

参数：

- dense_slots_name : slot名称的列表，这些slot将被设置为密集的

datafeed = fluid.DataFeedDesc('data.proto')
data_feed.set_dense_slots(['words'])

set_use_slots(_use_slots_name)

参数：

- use_slots_name :将在训练中使用的slot名列表

datafeed = fluid.DataFeedDesc('data.proto')
data_feed.set_use_slots(['words'])

data_feed = fluid.DataFeedDesc('data.proto')
print(data_feed.desc())

_class paddle.fluid.DataFeeder(feed_list, place, program=None)

place = fluid.CPUPlace()
img = fluid.layers.data(name='image', shape=[1, 28, 28])
label = fluid.layers.data(name='label', shape=[1], dtype='int64')
feeder = fluid.DataFeeder([img, label], fluid.CPUPlace())
result = feeder.feed([([0]  784, [9]), ([1]  784, [1])])

place=fluid.CUDAPlace(0)
feeder = fluid.DataFeeder(place=place, feed_list=[data, label])
reader = feeder.decorate_reader(
        paddle.batch(flowers.train(), batch_size=16))

# …
place = fluid.CPUPlace()
feed_list = [
        main_program.global_block().var(var_name) for var_name in feed_vars_name
] # feed_vars_name 是一个由变量名组成的列表
feeder = fluid.DataFeeder(feed_list, place)
for data in reader():
        outs = exe.run(program=main_program,
                       feed=feeder.feed(data))

feed(_iterable)

feed_parallel(_iterable, num_places=None)

参数:

- iterable (list|tuple) – 要输入的数据
- num_places (int) – 设备数目。默认为None。

decoratereader(_reader, multi_devices, num_places=None, drop_last=True)

参数：

- reader (fun) – 该参数是一个可以生成数据的函数
- multi_devices (bool) – bool型，指明是否使用多个设备
- num_places (int) – 如果 multidevices 为 True , 可以使用此参数来设置GPU数目。如果 num_places 为 None ，该函数默认使用当前训练机所有GPU设备。默认为None。
- drop_last (bool) – 如果最后一个batch的大小比 batch_size 要小，则可使用该参数来指明是否选择丢弃最后一个batch数据。 默认为 True

_class paddle.fluid.DistributeTranspiler(config=None)

#pserver模式下
pserver_endpoints = "192.168.0.1:6174,192.168.0.2:6174"
trainer_endpoints = "192.168.0.1:6174,192.168.0.2:6174"
current_endpoint = "192.168.0.1:6174"
trainer_id = 0
trainers = 4
role = os.getenv("PADDLE_TRAINING_ROLE")

t = fluid.DistributeTranspiler()
t.transpile(
     trainer_id, pservers=pserver_endpoints, trainers=trainers)
if role == "PSERVER":
     pserver_program = t.get_pserver_program(current_endpoint)
     pserver_startup_program = t.get_startup_program(current_endpoint,
                                             pserver_program)
elif role == "TRAINER":
     trainer_program = t.get_trainer_program()

# nccl2模式下
config = fluid.DistributeTranspilerConfig()
config.mode = "nccl2"
t = fluid.DistributeTranspiler(config=config)
t.transpile(trainer_id, workers=workers, current_endpoint=curr_ep)
exe = fluid.ParallelExecutor(
    use_cuda,
    loss_name=loss_var.name,
    num_trainers=len(trainers.split(",)),
    trainer_id=trainer_id
)

transpile(_trainer_id, program=None, pservers='127.0.0.1:6174', trainers=1, sync_mode=True, startup_program=None, current_endpoint='127.0.0.1:6174')

参数:

- trainer_id (int) – 当前Trainer worker的id, 如果有n个Trainer worker, id 取值范围为0 ~ n-1
- program (Program|None) – 待transpile（转译）的program, 缺省为 fluid.defaultmain_program()
- startup_program (Program|None) - 要转译的 startup_program ,默认为 fluid.default_startup_program()
- pservers (str) – 内容为Pserver列表的字符串，格式为：按逗号区分不同的Pserver，每个Pserver的格式为 _ip地址:端口号
- trainers (int|str) – 在Pserver模式下，该参数指Trainer机的个数；在nccl2模式下，它是一个内容为Trainer终端列表的字符串
- sync_mode (bool) – 是否做同步训练(synchronous training), 默认为True
- startup_program (Program|None) – 待transpile（转译）的startupprogram，默认为 fluid.default_main_program()
- current_endpoint (str) – 当需要把program转译（transpile）至NCCL2模式下时，需要将当前endpoint（终端）传入该参数。Pserver模式不使用该参数

get_trainer_program(_wait_port=True)

getpserver_program(_endpoint)

参数:

- endpoint (str) – 当前Pserver终端

getpserver_programs(_endpoint)

get_startup_program(_endpoint, pserver_program=None, startup_program=None)

_class paddle.fluid.DistributeTranspilerConfig

slicevar_up(_bool)

splitmethod(_PSDispatcher)

minblock_size(_int)

_class paddle.fluid.ExecutionStrategy

execstrategy = fluid.ExecutionStrategy()
exec_strategy.num_threads = 4

train_exe = fluid.ParallelExecutor(use_cuda=True,
                                   loss_name=loss.name,
                                   exec_strategy=exec_strategy)

train_loss, = train_exe.run([loss.name], feed=feed_dict)

_class paddle.fluid.Executor(place)

cpu = core.CPUPlace()
exe = Executor(cpu)
…
exe.close()

run(_program=None, feed=None, fetch_list=None, feed_var_name='feed', fetch_var_name='fetch', scope=None, return_numpy=True, use_program_cache=False)

data = layers.data(name='X', shape=[1], dtype='float32')
hidden = layers.fc(input=data, size=10)
layers.assign(hidden, out)
loss = layers.mean(out)
adam = fluid.optimizer.Adam()
adam.minimize(loss)

cpu = core.CPUPlace()
exe = Executor(cpu)
exe.run(default_startup_program())

x = numpy.random.random(size=(10, 1)).astype('float32')
outs = exe.run(
        feed={'X': x},
        fetch_list=[loss.name])

_class paddle.fluid.LoDTensor

x.lod  =  [[2, 3]]
x.data = [[1, 2], [3, 4], // seq 1

          [5, 6], [7, 8], [9, 10]] // seq 2

x.shape = [5, 2]

y.lod = [[2 1], [2 2 3]] y.shape = [2+2+3, …]

has_valid_recursive_sequence_lengths(self: paddle.fluid.core.LoDTensor) → bool

lod(self: paddle.fluid.core.LoDTensor) → List[List[int]]

recursive_sequence_lengths(self: paddle.fluid.core.LoDTensor) → List[List[int]]

set_lod(self: paddle.fluid.core.LoDTensor, arg0: List[List[int]]) → None

set_recursive_sequence_lengths(self: paddle.fluid.core.LoDTensor, arg0: List[List[int]]) → None

LoDTensorArray

SourceEnglish

class paddle.fluid.LoDTensorArray

append(self: paddle.fluid.core.LoDTensorArray, arg0: paddle.fluid.core.LoDTensor) → None

memory_optimize

SourceEnglish

paddle.fluid.memoryoptimize(_input_program, skip_opt_set=None, print_log=False, level=0, skip_grads=False)

参数:

- input_program (str) – 输入Program。
- skip_opt_set (set) – set中的vars将不被内存优化。
- print_log (bool) – 是否打印debug日志。
- level (int) 如果 level=0 并且shape是完全相等，则重用。

paddle.fluid.name_scope(args, kwds_)

with namescope("encoder"):
    …
with name_scope("decoder"):
    …
with name_scope("attention"):
    …

train_exe = fluid.ParallelExecutor(use_cuda=True, loss_name=loss.name)
test_exe = fluid.ParallelExecutor(use_cuda=True,
                                  main_program=test_program,
                                  share_vars_from=train_exe)

train_loss, = train_exe.run([loss.name], feed=feed_dict)
test_loss, = test_exe.run([loss.name], feed=feed_dict)

exe = ParallelExecutor()
# 图像会被split到设备中。假设有两个设备，那么每个设备将会处理形为 (24, 1, 28, 28)的图像
exe.run(feed={'image': numpy.random.random(size=(48, 1, 28, 28))})

exe = ParallelExecutor()
# 各设备挨个处理列表中的每个元素
# 第一个设备处理形为 (48, 1, 28, 28) 的图像
# 第二个设备处理形为 (32, 1, 28, 28) 的图像
#
# 使用 exe.device_count 得到设备数目
exe.run(feed=[{"image": numpy.random.random(size=(48, 1, 28, 28))},
              {"image": numpy.random.random(size=(32, 1, 28, 28))},
              ])

参数：

- fetch_list (list) – 获取的变量名列表
- feed (list|dict|None) – feed变量。 如果该参数是 dict 类型，feed中的数据将会被分割(split)并分送给多个设备（CPU/GPU）。反之，如果它是 list ，则列表中的各个元素都直接分别被拷贝到各设备中。默认为None
- feed_dict – 该参数已经停止使用。feed参数的别名, 为向后兼容而立。默认为None
- *return_numpy (bool) – 是否将fetched tensor转换为numpy。默认为True

抛出异常:

- ValueError - 如果feed参数是list类型，但是它的长度不等于可用设备（执行场所）的数目，再或者给定的feed不是dict类型，抛出此异常
- TypeError - 如果feed参数是list类型，但是它里面的元素不是dict类型时，弹出此异常

注解

• 如果feed参数为dict类型，那么传入 ParallelExecutor 的数据量 必须 大于可用的CPU核数或GPU卡数。否则，C++端将会抛出异常。应额外注意核对数据集的最后一个batch是否比可用的CPU核数或GPU卡数大。
• 如果可用的CPU核数或GPU卡数大于一个，则为每个变量最后获取的结果都是list类型，且这个list中的每个元素都是各CPU核或GPU卡上的变量

代码示例

pe = fluid.ParallelExecutor(use_cuda=use_cuda,
                            loss_name=avg_cost.name,
                            main_program=fluid.default_main_program())
loss = pe.run(feed=feeder.feed(cur_batch),
              fetch_list=[avg_cost.name]))

ParamAttr

SourceEnglish

class paddle.fluid.ParamAttr(name=None, initializer=None, learning_rate=1.0, regularizer=None, trainable=True, gradient_clip=None, do_model_average=False)

w_param_attrs = fluid.ParamAttr(name="fc_weight",
                                learning_rate=0.5,
                                regularizer=fluid.L2Decay(1.0),
                                trainable=True)
y_predict = fluid.layers.fc(input=x, size=10, param_attr=w_param_attrs)

_class paddle.fluid.Program

main_program = fluid.Program()
startup_program = fluid.Program()
with fluid.program_guard(main_program=main_program, startup_program=startup_program):
      fluid.layers.data(name="x", shape=[-1, 784], dtype='float32')
      fluid.layers.data(name="y", shape=[-1, 1], dtype='int32')
      fluid.layers.fc(name="fc", shape=[10], dtype='float32', act="relu")

to_string(_throw_on_error, with_details=False)

参数：

- throw_on_error (bool): 没有设置任何必需的字段时，抛出值错误。
- with_details (bool): 值为true时，打印更多关于变量和参数的信息，如trainable, optimizeattr等

clone(_for_test=False)

test_program = fluid.default_main_program().clone(for_test=True)
optimizer = fluid.optimizer.Momentum(learning_rate=0.01, momentum=0.9)
optimizer.minimize()

train_program = fluid.Program()
startup_program = fluid.Program()
with fluid.program_guard(train_program, startup_program):
      img = fluid.layers.data(name='image', shape=[784])
      hidden = fluid.layers.fc(input=img, size=200, act='relu')
      hidden = fluid.layers.dropout(hidden, dropout_prob=0.5)
      loss = fluid.layers.cross_entropy(
                   input=fluid.layers.fc(hidden, size=10, act='softmax'),
                   label=fluid.layers.data(name='label', shape=[1], dtype='int64'))
test_program = train_program.clone(for_test=True)
sgd = fluid.optimizer.SGD(learning_rate=1e-3)
with fluid.program_guard(train_program, startup_program):
      sgd.minimize(loss)

import paddle.fluid as fluid

def network(is_test):
     img = fluid.layers.data(name='image', shape=[784])
     hidden = fluid.layers.fc(input=img, size=200, act='relu')
     hidden = fluid.layers.dropout(hidden, dropout_prob=0.5, is_test=is_test)
     loss = fluid.layers.cross_entropy(
                 input=fluid.layers.fc(hidden, size=10, act='softmax'),
                 label=fluid.layers.data(name='label', shape=[1], dtype='int64'))
     return loss

 train_program = fluid.Program()
 startup_program = fluid.Program()
 test_program = fluid.Program()

 with fluid.program_guard(train_program, startup_program):
     with fluid.unique_name.guard():
         loss = network(is_test=False)
         sgd = fluid.optimizer.SGD(learning_rate=1e-3)
         sgd.minimize(loss)

 # 不使用测试阶段的startup program
 with fluid.program_guard(test_program, fluid.Program()):
     with fluid.unique_name.guard():
         loss = network(is_test=True)

_static parsefrom_string(_binary_str)

参数:

- binary_str_type (str) – prootbuf二进制字符串

numblocks

block(_index)

currentblock()

paddle.fluid.program_guard(args, kwds_)

import paddle.fluid as fluid
main_program = fluid.Program()
startup_program = fluid.Program()
with fluid.program_guard(main_program, startup_program):
        data = fluid.layers.data(…)
        hidden = fluid.layers.fc(…)

import paddle.fluid as fluid
main_program = fluid.Program()
# 如果您不需要关心startup program,传入一个临时值即可
with fluid.program_guard(main_program, fluid.Program()):
        data = …

参数：

- main_program (Program) – “with”语句中将使用的新的main program。
- startup_program* (Program) – “with”语句中将使用的新的startup program。若传入 None 则不改变当前的启动程序。

release_memory

SourceEnglish

paddle.fluid.releasememory(_input_program, skip_opt_set=None)

paddle.fluid.scope_guard(args, kwds_)

import paddle.fluid as fluid

newscope = fluid.Scope()
with fluid.scopeguard(new_scope):
        …

paddle.fluid.Tensor()

LoDTensor 的别名

WeightNormParamAttr

SourceEnglish

class paddle.fluid.WeightNormParamAttr(dim=None, name=None, initializer=None, learning_rate=1.0, regularizer=None, trainable=True, gradient_clip=None, do_model_average=False)

参数:

• dim (list) - 参数的名称。默认None。
• name (str) - 参数的名称。默认None。
• initializer （initializer) - 初始化参数的方法。默认None。
• learning_rate (float) - 学习率。优化时学习速率 (global_lr∗parameter_lr∗scheduler_factor) 。默认1.0。
• regularizer (WeightDecayRegularizer) - 正则化因子。默认None。
• trainable (bool) - 参数是否可训练。默认True。
• gradient_clip (BaseGradientClipAttr) - 梯度下降裁剪（Gradient Clipping）的方法。默认None。
• do_model_average (bool) - 参数是否应该model average。默认False。

代码示例

data = fluid.layers.data(name="data", shape=[3, 32, 32], dtype="float32")
fc = fluid.layers.fc(input=data,
                     size=1000,
                     param_attr=WeightNormParamAttr(
                          dim=None,
                          name='weight_norm_param'))

原文: http://paddlepaddle.org/documentation/docs/zh/1.3/api_cn/fluid_cn.html