distributed_strategy.py 88.7 KB
Newer Older
1 2
# Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
# Copyright (c) 2021 NVIDIA Corporation. All rights reserved.
3 4 5 6 7 8 9 10 11 12 13 14 15
#
# 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.

16 17 18
import google.protobuf
import google.protobuf.text_format

19
import paddle
20
from paddle.distributed.fleet.proto import distributed_strategy_pb2
21
from paddle.distributed.fleet.utils.log_util import logger
22
from paddle.fluid.framework import _global_flags
23
from paddle.fluid.wrapped_decorator import wrap_decorator
24

R
risemeup1 已提交
25 26
protobuf_version = google.protobuf.__version__
if protobuf_version >= "4.21.0":
27
    from google._upb import _message
R
risemeup1 已提交
28
else:
29
    from google.protobuf.pyext import _message
R
risemeup1 已提交
30

31
__all__ = []
32

33 34 35 36 37 38 39 40 41 42 43 44 45 46
non_auto_func_called = True


def __non_auto_func_called__(func):
    def __impl__(*args, **kwargs):
        global non_auto_func_called
        non_auto_func_called = False
        return func(*args, **kwargs)

    return __impl__


is_strict_auto = wrap_decorator(__non_auto_func_called__)

47

48 49 50 51 52 53 54 55 56 57 58 59 60
def get_msg_dict(msg):
    res_dict = {}
    fields = msg.DESCRIPTOR.fields
    for f in fields:
        res_dict[f.name] = getattr(msg, f.name)
    return res_dict


def assign_configs_value(msg, config):
    fields = msg.DESCRIPTOR.fields
    for key in config:
        for f in fields:
            if key == f.name:
61 62 63
                # LABEL_OPTIONAL = 1
                # LABEL_REPEATED = 3
                # LABEL_REQUIRED = 2
64
                if f.label == 3:
S
sneaxiy 已提交
65 66
                    if config[f.name] is not None:
                        getattr(msg, f.name).extend(config[f.name])
67 68 69 70 71 72 73 74 75 76
                elif f.label == 1 or f.label == 2:
                    setattr(msg, f.name, config[f.name])


def check_configs_key(msg, config, field_name):
    key_list = msg.DESCRIPTOR.fields_by_name.keys()
    for key in config:
        assert key in key_list, "key:{} not in {}".format(key, field_name)


77
class DistributedJobInfo:
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    """
    DistributedJobInfo will serialize all distributed training information
    Just for inner use: 1) debug 2) replicate experiments
    """

    def __init__(self):
        self.job_info = distributed_strategy_pb2.DistributedJobInfo()

    def _set_worker_num(self, worker_num):
        self.job_info.worker_num = worker_num

    def _set_server_num(self, server_num):
        self.job_info.server_num = server_num

    def _set_worker_ips(self, worker_ips):
        self.job_info.worker_ips.extend(worker_ips)

    def _set_server_endpoints(self, server_endpoints):
        self.job_info.server_endpoints.extend(server_endpoints)

    def _set_origin_startup(self, origin_startup_prog):
        self.job_info.origin_startup = str(origin_startup_prog)

    def _set_origin_main(self, origin_main_prog):
        self.job_info.origin_main = str(origin_main_prog)

    def _distributed_main(self, distributed_main_prog):
        self.job_info.distributed_main = str(distributed_main_prog)

    def _optimizer_name(self, optimizer_name):
        self.job_info.optimizer_name = optimizer_name

    def _set_distributed_strategy(self, dist_strategy):
        self.job_info.strategy = dist_strategy


114 115 116
ReduceStrategyFleet = int


117
class DistributedStrategy:
118 119
    __lock_attr = False

120
    def __init__(self):
121
        """
122

123 124
        DistributedStrategy is the main configuration entry for distributed training of Paddle.
        All of the distributed training configurations can be configured in DistributedStrategy,
125
        such as automatic mixed precision (AMP), Layer-wise Adaptive Rate Scaling (LARS),
126
        asynchronous update parameter server(ASGD), etc.
1
123malin 已提交
127

128 129
        DistributedStrategy can be serialized into protobuf file or deserialized from protobuf file

130
        Users who run local training usually configure BuildStrategy and ExecutionStrategy, and
131 132 133
        DistributedStrategy supports configurations from BuildStrategy and ExecutionStrategy

        """
134
        self.strategy = distributed_strategy_pb2.DistributedStrategy()
135 136 137

        # Set the default values of the following flags to the ones set by users
        key = 'FLAGS_cudnn_batchnorm_spatial_persistent'
138
        if _global_flags().is_public(key):
139
            self.strategy.cudnn_batchnorm_spatial_persistent = bool(
140 141
                _global_flags()[key]
            )
142
        key = 'FLAGS_conv_workspace_size_limit'
143 144
        if _global_flags().is_public(key):
            self.strategy.conv_workspace_size_limit = int(_global_flags()[key])
145
        key = 'FLAGS_cudnn_exhaustive_search'
146 147
        if _global_flags().is_public(key):
            self.strategy.cudnn_exhaustive_search = bool(_global_flags()[key])
148
        key = 'FLAGS_sync_nccl_allreduce'
149 150
        if _global_flags().is_public(key):
            self.strategy.sync_nccl_allreduce = bool(_global_flags()[key])
151

152
        self.__lock_attr = True
153
        logger.info("distributed strategy initialized")
154 155 156

    def __setattr__(self, key, value):
        if self.__lock_attr and not hasattr(self, key):
157 158 159
            raise TypeError(
                "%s is not a attribute of %s" % (key, self.__class__.__name__)
            )
160
        object.__setattr__(self, key, value)
161

162
    def save_to_prototxt(self, output):
163
        """
164

165 166 167
        Serialize current DistributedStrategy to string and save to output file

        Examples:
168
            .. code-block:: python
1
123malin 已提交
169

170 171 172 173 174 175
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.dgc = True
                strategy.recompute = True
                strategy.recompute_configs = {"checkpoints": ["x"]}
                strategy.save_to_prototxt("dist_strategy.prototxt")
1
123malin 已提交
176

177
        """
178 179 180 181
        with open(output, "w") as fout:
            fout.write(str(self.strategy))

    def load_from_prototxt(self, pb_file):
182
        """
183

184 185 186
        Load from prototxt file for DistributedStrategy initialization

        Examples:
187
            .. code-block:: python
1
123malin 已提交
188

189 190 191
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.load_from_prototxt("dist_strategy.prototxt")
192 193 194 195

        """
        with open(pb_file, 'r') as f:
            self.strategy = google.protobuf.text_format.Merge(
196 197
                str(f.read()), self.strategy
            )
198 199 200 201 202 203 204

    @property
    def execution_strategy(self):
        """
        Configure ExecutionStrategy for DistributedStrategy

        Examples:
205
            .. code-block:: python
1
123malin 已提交
206

207 208 209 210 211
                import paddle
                exe_strategy = paddle.static.ExecutionStrategy()
                exe_strategy.num_threads = 10
                exe_strategy.num_iteration_per_drop_scope = 10
                exe_strategy.num_iteration_per_run = 10
212

213 214
                strategy = paddle.distributed.fleet.DistributedStrategy()
                strategy.execution_strategy = exe_strategy
215 216

        """
W
wangxiaoning 已提交
217
        execution_strategy = paddle.static.ExecutionStrategy()
218 219
        fields = self.strategy.execution_strategy.DESCRIPTOR.fields
        for f in fields:
220 221 222 223 224
            setattr(
                execution_strategy,
                f.name,
                getattr(self.strategy.execution_strategy, f.name),
            )
225 226 227
        return execution_strategy

    @execution_strategy.setter
228
    @is_strict_auto
229 230 231
    def execution_strategy(self, strategy):
        fields = self.strategy.execution_strategy.DESCRIPTOR.fields
        for f in fields:
232 233 234 235 236
            setattr(
                self.strategy.execution_strategy,
                f.name,
                getattr(strategy, f.name),
            )
237 238 239 240

    @property
    def build_strategy(self):
        """
241

242 243 244 245 246
        Configure BuildStrategy for DistributedStrategy
        Note that the properties of BuildStrategy are valid in DistributedStrategy
        only if the property is non-distributed strategy.

        Examples:
247
            .. code-block:: python
1
123malin 已提交
248

249 250 251 252 253 254 255 256 257 258
                import paddle
                build_strategy = paddle.static.BuildStrategy()
                build_strategy.enable_sequential_execution = True
                build_strategy.fuse_elewise_add_act_ops = True
                build_strategy.fuse_bn_act_ops = True
                build_strategy.enable_auto_fusion = True
                build_strategy.fuse_relu_depthwise_conv = True
                build_strategy.fuse_broadcast_ops = True
                build_strategy.fuse_all_optimizer_ops = True
                build_strategy.enable_inplace = True
259

260 261
                strategy = paddle.distributed.fleet.DistributedStrategy()
                strategy.build_strategy = build_strategy
1
123malin 已提交
262

263 264
        """

W
wangxiaoning 已提交
265
        build_strategy = paddle.static.BuildStrategy()
266 267
        fields = self.strategy.build_strategy.DESCRIPTOR.fields
        for f in fields:
268 269
            value = getattr(self.strategy.build_strategy, f.name)
            if f.name == 'reduce_strategy':
270
                value = paddle.static.BuildStrategy.ReduceStrategy(value)
271
            setattr(build_strategy, f.name, value)
272 273 274
        return build_strategy

    @build_strategy.setter
275
    @is_strict_auto
276 277 278 279
    def build_strategy(self, strategy):
        fields = self.strategy.build_strategy.DESCRIPTOR.fields
        for f in fields:
            if f.label == 1 or f.label == 2:  # optional and required field
280 281 282 283
                value = getattr(strategy, f.name)
                if f.name == 'reduce_strategy':
                    value = ReduceStrategyFleet(value)
                setattr(self.strategy.build_strategy, f.name, value)
284
            elif f.label == 3:  # repeated field
285 286 287
                getattr(self.strategy.build_strategy, f.name).extend(
                    getattr(strategy, f.name)
                )
288 289

    @property
Y
Yuang Liu 已提交
290 291
    def gradient_scale_configs(self):
        """
292

Y
Yuang Liu 已提交
293
        Set the strategy of gradient scale
294

Y
Yuang Liu 已提交
295
        Examples:
296
            .. code-block:: python
Y
Yuang Liu 已提交
297

298 299 300
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.gradient_scale_configs = {'scale_strategy': 'avg'}
Y
Yuang Liu 已提交
301 302

        Note that, strategy must be in 'avg', 'sum' or 'customized'
303

Y
Yuang Liu 已提交
304 305 306 307 308 309
        """
        return get_msg_dict(self.strategy.gradient_scale_configs)

    @gradient_scale_configs.setter
    @is_strict_auto
    def gradient_scale_configs(self, config):
310 311 312 313 314
        check_configs_key(
            self.strategy.gradient_scale_configs,
            config,
            'gradient_scale_configs',
        )
Y
Yuang Liu 已提交
315 316 317
        assign_configs_value(self.strategy.gradient_scale_configs, config)

    @property
D
Dong Daxiang 已提交
318
    def a_sync(self):
319
        """
320

321
        Indicating whether we are using asynchronous stocastic gradient descent updates
322
        for training. This property is valid when we are using parameter server training,
323 324 325 326
        which is implied by setting approperate RoleMaker
        Default value: True

        Examples:
327
            .. code-block:: python
1
123malin 已提交
328

329 330 331
                import paddle.distributed.fleet as fleet
                role_maker = fleet.PaddleCloudRoleMaker()
                fleet.init(role_maker)
332

333 334
                strategy = fleet.DistributedStrategy()
                strategy.a_sync = True  # by default this is True
335

336 337
                # code block for defining loss and local optimizer
                # sgd = fleet.distributed_optimizer(optimizer, strategy)
1
123malin 已提交
338

339
        """
D
Dong Daxiang 已提交
340
        return self.strategy.a_sync
341

D
Dong Daxiang 已提交
342
    @a_sync.setter
343
    @is_strict_auto
D
Dong Daxiang 已提交
344
    def a_sync(self, flag):
345
        if isinstance(flag, bool):
D
Dong Daxiang 已提交
346
            self.strategy.a_sync = flag
347
            self.a_sync_configs = {"k_steps": 0}
348
        else:
349
            raise ValueError(
350 351 352 353
                "The type of `flag` is invalid, expected type is bool, but received {}".format(
                    type(flag)
                )
            )
354 355

    @property
D
Dong Daxiang 已提交
356
    def a_sync_configs(self):
357
        """
358

D
Dong Daxiang 已提交
359
        Set a_sync update configurations. In general, asynchronous parameter server
360 361
        training has serveral configurable settings that can be configured through
        a dict.
362

363
        **Notes**:
M
mapingshuo 已提交
364 365 366 367 368 369 370 371 372 373 374 375 376
            k_step(int): number of local optimization updates before communication

            max_merge_var_num(int): maximum number of merged gradients before communication

            send_queue_size(int): a buffer size of worker communication

            independent_recv_thread(bool): if we are using independent recv thread for communication

            thread_pool_size(int): number of thread pool

            send_wait_times(int): waiting time for sending gradients

            runtime_split_send_recv(bool): if we are using Tensor split for send and recv during runtime
377

378
        Examples:
379
            .. code-block:: python
1
123malin 已提交
380

381 382 383
                import paddle.distributed.fleet as fleet
                role_maker = fleet.PaddleCloudRoleMaker()
                fleet.init(role_maker)
384

385 386 387 388
                strategy = fleet.DistributedStrategy()
                strategy.a_sync = True  # by default this is True
                configs = {"k_steps": 1024, "send_queue_size": 32}
                strategy.a_sync_configs = configs
389

390 391
                # code block for defining loss and local optimizer
                # sgd = fleet.distributed_optimizer(optimizer, strategy)
M
mapingshuo 已提交
392

393
        """
D
Dong Daxiang 已提交
394
        return get_msg_dict(self.strategy.a_sync_configs)
395

D
Dong Daxiang 已提交
396
    @a_sync_configs.setter
397
    @is_strict_auto
D
Dong Daxiang 已提交
398
    def a_sync_configs(self, configs):
399 400 401
        check_configs_key(
            self.strategy.a_sync_configs, configs, "a_sync_configs"
        )
D
Dong Daxiang 已提交
402
        assign_configs_value(self.strategy.a_sync_configs, configs)
403

404 405 406
    @property
    def trainer_desc_configs(self):
        """
407

408
        Set trainer desc configurations.
409 410 411 412 413 414 415 416

        **Notes**:
            dump_fields_path(str): the path of dump fields

            dump_fields(list(str)): the fields that you want to dump

            dump_param(list(str)): the param that you want to dump

417
            stat_var_names(list(str)):
418 419

        Examples:
420
            .. code-block:: python
421

422 423 424
                import paddle.distributed.fleet as fleet
                role_maker = fleet.PaddleCloudRoleMaker()
                fleet.init(role_maker)
425

426 427 428
                strategy = fleet.DistributedStrategy()
                configs = {"dump_fields_path": "./dump_data", "dump_fields": ["xxx", "yyy"]}
                strategy.trainer_desc_configs = configs
429

430 431
                # code block for defining loss and local optimizer
                # sgd = fleet.distributed_optimizer(optimizer, strategy)
432 433 434 435

        """
        return get_msg_dict(self.strategy.trainer_desc_configs)

436 437 438
    @property
    def adam_d2sum(self):
        """
439

440
        set adam_d2sum
W
wangguanqun 已提交
441
        Default value: False
442 443

        Examples:
444
            .. code-block:: python
445

446 447 448
                import paddle.distributed.fleet as fleet
                role_maker = fleet.PaddleCloudRoleMaker()
                fleet.init(role_maker)
449

450 451
                strategy = fleet.DistributedStrategy()
                strategy.adam_d2sum = True  # by default this is False
452

453 454
                # code block for defining loss and local optimizer
                # sgd = fleet.distributed_optimizer(optimizer, strategy)
455 456 457 458 459 460 461 462 463 464 465

        """
        return self.strategy.adam_d2sum

    @adam_d2sum.setter
    @is_strict_auto
    def adam_d2sum(self, flag):
        if isinstance(flag, bool):
            self.strategy.adam_d2sum = flag
        else:
            raise ValueError(
466 467 468 469
                "The type of `flag` is invalid, expected type is bool, but received {}".format(
                    type(flag)
                )
            )
470

471 472 473
    @trainer_desc_configs.setter
    @is_strict_auto
    def trainer_desc_configs(self, configs):
474 475 476
        check_configs_key(
            self.strategy.trainer_desc_configs, configs, "trainer_desc_configs"
        )
477 478
        assign_configs_value(self.strategy.trainer_desc_configs, configs)

479 480 481
    @property
    def fs_client_param(self):
        """
482

483
        Set fs client configurations.
484 485

        Note:
486
            uri(str): the uri of fs client
487

488
            user(str): the user_name of fs client
489

490
            passwd(str): the passwd of fs client
491

492
            hadoop_bin(str):
493

494
        Examples:
495 496 497 498 499 500 501 502 503 504 505
            .. code-block:: python

                import paddle.distributed.fleet as fleet
                role_maker = fleet.PaddleCloudRoleMaker()
                fleet.init(role_maker)
                strategy = fleet.DistributedStrategy()
                configs = {"uri": "xxx", "user": "xxx", passwd: "xxx"}
                strategy.fs_client_param = configs
                # code block for defining loss and local optimizer
                # sgd = fleet.distributed_optimizer(optimizer, strategy)

506 507 508 509 510 511
        """
        return self.strategy.fs_client_param

    @fs_client_param.setter
    @is_strict_auto
    def fs_client_param(self, configs):
512 513 514
        check_configs_key(
            self.strategy.fs_client_param, configs, "fs_client_param"
        )
515 516 517 518 519 520 521 522 523 524
        assign_configs_value(self.strategy.fs_client_param, configs)

    @property
    def sparse_table_configs(self):
        return self.strategy.downpour_table_param

    @sparse_table_configs.setter
    @is_strict_auto
    def sparse_table_configs(self, configs):
        from google.protobuf.descriptor import FieldDescriptor
525

526 527
        table_param = self.strategy.downpour_table_param

528
        def set_table_config(msg, config_name, configs, index=0):
529 530 531
            for field in msg.DESCRIPTOR.fields:
                name = config_name + "." + field.name
                if field.type == FieldDescriptor.TYPE_MESSAGE:
532
                    logger.debug(f"message: {name}")
533 534 535 536
                    if field.label == FieldDescriptor.LABEL_REPEATED:
                        if name + ".num" not in configs:
                            continue
                        num = configs[name + ".num"]
537
                        logger.debug(f"message num: {name} {num}")
538 539 540 541
                        for i in range(num):
                            data = getattr(msg, field.name).add()
                            set_table_config(data, name, configs, i)
                    else:
542 543 544
                        set_table_config(
                            getattr(msg, field.name), name, configs
                        )
545
                else:
546
                    logger.debug("not message: %s", name)
547 548 549 550 551
                    if name not in configs:
                        continue
                    if field.label == FieldDescriptor.LABEL_REPEATED:
                        getattr(msg, field.name).extend(configs[name])
                    else:
552 553 554 555
                        if type(configs[name]) == list:
                            setattr(msg, field.name, configs[name][index])
                        else:
                            setattr(msg, field.name, configs[name])
556

557
        if not configs:
558
            logger.info("table configs is empty")
559
        else:
560 561 562
            for table_name in configs:
                table_data = table_param.add()
                table_data.table_name = table_name
563 564 565 566 567
                set_table_config(
                    table_data,
                    "table_parameters." + table_name,
                    configs[table_name],
                )
568

569 570
    @sparse_table_configs.setter
    def fleet_desc_configs(self, configs):
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
        support_sparse_key_list = [
            'sparse_table_class',
            'sparse_compress_in_save',
            'sparse_shard_num',
            'sparse_accessor_class',
            'sparse_learning_rate',
            'sparse_initial_g2sum',
            'sparse_initial_range',
            'sparse_weight_bounds',
            'sparse_fea_dim',
            'sparse_embedx_dim',
            'sparse_embedx_threshold',
            'sparse_nonclk_coeff',
            'sparse_click_coeff',
            'sparse_base_threshold',
            'sparse_delta_threshold',
            'sparse_delta_keep_days',
            'sparse_delete_after_unseen_days',
            'sparse_show_click_decay_rate',
            'sparse_delete_threshold',
            'sparse_converter',
            'sparse_deconverter',
            'sparse_enable_cache',
            'sparse_cache_rate',
            'sparse_cache_file_num',
            'sparse_beta1_decay_rate',
            'sparse_beta2_decay_rate',
            'sparse_ada_epsilon',
            'sparse_optimizer',
            'sparse_ssd_unseenday_threshold',
            'embed_sparse_optimizer',
            'embed_sparse_learning_rate',
            'embed_sparse_weight_bounds',
            'embed_sparse_initial_range',
            'embed_sparse_initial_g2sum',
            'embed_sparse_beta1_decay_rate',
            'embed_sparse_beta2_decay_rate',
            'embedx_sparse_optimizer',
            'embedx_sparse_learning_rate',
            'embedx_sparse_weight_bounds',
            'embedx_sparse_initial_range',
            'embedx_sparse_initial_g2sum',
            'embedx_sparse_beta1_decay_rate',
            'embedx_sparse_beta2_decay_rate',
            'feature_learning_rate',
            'nodeid_slot',
L
lxsbupt 已提交
617 618 619 620 621
            'sparse_load_filter_slots',
        ]
        support_sparse_table_class = [
            'DownpourSparseTable',
            'DownpourSparseSSDTable',
622
        ]
623
        support_sparse_accessor_class = [
624 625 626 627 628 629
            'DownpourSparseValueAccessor',
            'DownpourCtrAccessor',
            'DownpourCtrDoubleAccessor',
            'DownpourUnitAccessor',
            'DownpourDoubleUnitAccessor',
            'DownpourCtrDymfAccessor',
630 631 632
        ]
        table_param = self.strategy.downpour_table_param

D
danleifeng 已提交
633
        def add_graph_config(graph, strategy):
634 635 636
            graph.feature_learning_rate = strategy.get(
                'feature_learning_rate', 0.05
            )
D
danleifeng 已提交
637 638
            graph.nodeid_slot = strategy.get('nodeid_slot', 9008)

639
        def sparse_optimizer_config(sgd, strategy, prefix):
640 641 642
            optimizer_name = strategy.get(
                prefix + "sparse_optimizer", "adagrad"
            )
643 644 645 646
            sgd.name = optimizer_name
            if optimizer_name == "naive":
                sgd.name = "SparseNaiveSGDRule"
                sgd.naive.learning_rate = strategy.get(
647 648
                    prefix + 'sparse_learning_rate', 0.05
                )
649
                sgd.naive.initial_range = strategy.get(
650 651 652 653 654
                    prefix + 'sparse_initial_range', 1e-4
                )
                bounds = strategy.get(
                    prefix + 'sparse_weight_bounds', [-10, 10]
                )
655 656 657 658
                sgd.naive.weight_bounds.extend(bounds)
            elif optimizer_name == "adagrad":
                sgd.name = 'SparseAdaGradSGDRule'
                sgd.adagrad.learning_rate = strategy.get(
659 660
                    prefix + 'sparse_learning_rate', 0.05
                )
661
                sgd.adagrad.initial_range = strategy.get(
662 663
                    prefix + 'sparse_initial_range', 1e-4
                )
664 665 666
                if prefix == "embed_":
                    sgd.adagrad.initial_range = 0
                sgd.adagrad.initial_g2sum = strategy.get(
667 668 669 670 671
                    prefix + 'sparse_initial_g2sum', 3
                )
                bounds = strategy.get(
                    prefix + 'sparse_weight_bounds', [-10, 10]
                )
672 673 674 675
                sgd.adagrad.weight_bounds.extend(bounds)
            elif optimizer_name == "std_adagrad":
                sgd.name = 'StdAdaGradSGDRule'
                sgd.adagrad.learning_rate = strategy.get(
676 677
                    prefix + 'sparse_learning_rate', 0.05
                )
678
                sgd.adagrad.initial_range = strategy.get(
679 680
                    prefix + 'sparse_initial_range', 1e-4
                )
681 682 683
                if prefix == "embed_":
                    sgd.adagrad.initial_range = 0
                sgd.adagrad.initial_g2sum = strategy.get(
684 685 686 687 688
                    prefix + 'sparse_initial_g2sum', 3
                )
                bounds = strategy.get(
                    prefix + 'sparse_weight_bounds', [-10, 10]
                )
689 690 691
                sgd.adagrad.weight_bounds.extend(bounds)
            elif optimizer_name == "adam":
                sgd.name = 'SparseAdamSGDRule'
D
danleifeng 已提交
692
                sgd.adam.learning_rate = strategy.get(
693 694
                    prefix + 'sparse_learning_rate', 0.001
                )
D
danleifeng 已提交
695
                sgd.adam.initial_range = strategy.get(
696 697
                    prefix + 'sparse_initial_range', 1e-4
                )
D
danleifeng 已提交
698
                sgd.adam.beta1_decay_rate = strategy.get(
699 700
                    prefix + 'sparse_beta1_decay_rate', 0.9
                )
D
danleifeng 已提交
701
                sgd.adam.beta2_decay_rate = strategy.get(
702 703
                    prefix + 'sparse_beta2_decay_rate', 0.999
                )
D
danleifeng 已提交
704
                sgd.adam.ada_epsilon = strategy.get(
705 706 707 708 709
                    prefix + 'sparse_ada_epsilon', 1e-8
                )
                bounds = strategy.get(
                    prefix + 'sparse_weight_bounds', [-10, 10]
                )
D
danleifeng 已提交
710 711 712
                sgd.adam.weight_bounds.extend(bounds)
            elif optimizer_name == "shared_adam":
                sgd.name = 'SparseSharedAdamSGDRule'
713
                sgd.adam.learning_rate = strategy.get(
714 715
                    prefix + 'sparse_learning_rate', 0.001
                )
716
                sgd.adam.initial_range = strategy.get(
717 718
                    prefix + 'sparse_initial_range', 1e-4
                )
719
                sgd.adam.beta1_decay_rate = strategy.get(
720 721
                    prefix + 'sparse_beta1_decay_rate', 0.9
                )
722
                sgd.adam.beta2_decay_rate = strategy.get(
723 724
                    prefix + 'sparse_beta2_decay_rate', 0.999
                )
725
                sgd.adam.ada_epsilon = strategy.get(
726 727 728 729 730
                    prefix + 'sparse_ada_epsilon', 1e-8
                )
                bounds = strategy.get(
                    prefix + 'sparse_weight_bounds', [-10, 10]
                )
731 732 733 734 735 736
                sgd.adam.weight_bounds.extend(bounds)

        def set_sparse_table_config(table_data, config):
            for key in config:
                if key not in support_sparse_key_list:
                    raise ValueError("strategy key '%s' not support" % (key))
737 738 739
            table_class = config.get(
                "sparse_table_class", "DownpourSparseTable"
            )
740 741
            if table_class not in support_sparse_table_class:
                raise ValueError(
L
lxsbupt 已提交
742
                    "support sparse_table_class: ['DownpourSparseTable, DownpourSparseSSDTable'], but actual %s"
743 744
                    % (table_class)
                )
L
lxsbupt 已提交
745 746 747 748
            if table_class == "DownpourSparseSSDTable":
                table_data.table_class = 'SSDSparseTable'
            else:
                table_data.table_class = 'MemorySparseTable'
749
            table_data.shard_num = config.get('sparse_shard_num', 1000)
750
            table_data.enable_sparse_table_cache = config.get(
751 752
                'sparse_enable_cache', True
            )
753
            table_data.sparse_table_cache_rate = config.get(
754 755
                'sparse_cache_rate', 0.00055
            )
756
            table_data.sparse_table_cache_file_num = config.get(
757 758
                'sparse_cache_file_num', 16
            )
759

760 761 762
            accessor_class = config.get(
                "sparse_accessor_class", "DownpourCtrAccessor"
            )
763 764
            if accessor_class not in support_sparse_accessor_class:
                raise ValueError(
765
                    "support sparse_accessor_class: ['DownpourSparseValueAccessor', 'DownpourCtrAccessor', 'DownpourCtrDoubleAccessor', 'DownpourUnitAccessor', 'DownpourDoubleUnitAccessor'], but actual %s"
766 767
                    % (accessor_class)
                )
768

769 770
            if accessor_class.find("Double") >= 0:
                table_data.accessor.accessor_class = 'CtrDoubleAccessor'
771 772
            elif accessor_class.find("Dymf") >= 0:
                table_data.accessor.accessor_class = 'CtrDymfAccessor'
773
            else:
774 775 776
                table_data.accessor.accessor_class = 'CtrCommonAccessor'

            if not configs.get("use_cvm", True):
777 778 779 780 781
                table_data.accessor.accessor_class = 'SparseAccessor'

            table_data.accessor.embedx_dim = config.get('sparse_embedx_dim', 8)
            table_data.accessor.fea_dim = table_data.accessor.embedx_dim + 3
            table_data.accessor.embedx_threshold = config.get(
782 783
                'sparse_embedx_threshold', 10
            )
784

785 786 787 788 789
            if accessor_class == 'DownpourUnitAccessor':
                table_data.accessor.ctr_accessor_param.show_scale = False
            else:
                table_data.accessor.ctr_accessor_param.show_scale = True

790
            table_data.accessor.ctr_accessor_param.nonclk_coeff = config.get(
791 792
                'sparse_nonclk_coeff', 0.1
            )
793
            table_data.accessor.ctr_accessor_param.click_coeff = config.get(
794 795
                'sparse_click_coeff', 1
            )
796
            table_data.accessor.ctr_accessor_param.base_threshold = config.get(
797 798
                'sparse_base_threshold', 1.5
            )
799
            table_data.accessor.ctr_accessor_param.delta_threshold = config.get(
800 801
                'sparse_delta_threshold', 0.25
            )
802
            table_data.accessor.ctr_accessor_param.delta_keep_days = config.get(
803 804 805 806 807 808 809 810 811 812 813 814 815 816
                'sparse_delta_keep_days', 16
            )
            table_data.accessor.ctr_accessor_param.show_click_decay_rate = (
                config.get('sparse_show_click_decay_rate', 0.98)
            )
            table_data.accessor.ctr_accessor_param.delete_threshold = (
                config.get('sparse_delete_threshold', 0.8)
            )
            table_data.accessor.ctr_accessor_param.delete_after_unseen_days = (
                config.get('sparse_delete_after_unseen_days', 30)
            )
            table_data.accessor.ctr_accessor_param.ssd_unseenday_threshold = (
                config.get('sparse_ssd_unseenday_threshold', 1)
            )
L
lxsbupt 已提交
817 818 819 820
            load_filter_slots = config.get('sparse_load_filter_slots', [])
            table_data.accessor.ctr_accessor_param.load_filter_slots.extend(
                load_filter_slots
            )
821 822 823 824 825 826 827 828 829 830 831 832 833
            converter = config.get('sparse_converter', "")
            deconverter = config.get('sparse_deconverter', "")

            save_data1 = table_data.accessor.table_accessor_save_param.add()
            save_data1.param = 1
            save_data1.converter = converter
            save_data1.deconverter = deconverter

            save_data2 = table_data.accessor.table_accessor_save_param.add()
            save_data2.param = 2
            save_data2.converter = converter
            save_data2.deconverter = deconverter

834 835 836 837 838 839 840 841 842 843
            if (
                accessor_class == 'DownpourCtrAccessor'
                or accessor_class == 'DownpourCtrDoubleAccessor'
            ):
                sparse_optimizer_config(
                    table_data.accessor.embed_sgd_param, config, ''
                )
                sparse_optimizer_config(
                    table_data.accessor.embedx_sgd_param, config, ''
                )
844
            else:
845 846 847 848 849 850
                sparse_optimizer_config(
                    table_data.accessor.embed_sgd_param, config, 'embed_'
                )
                sparse_optimizer_config(
                    table_data.accessor.embedx_sgd_param, config, 'embedx_'
                )
D
danleifeng 已提交
851
            add_graph_config(table_data.accessor.graph_sgd_param, config)
852 853

        if not configs:
854
            logger.info("fleet desc config is empty")
855 856
        else:
            for table_name in configs:
857 858 859 860
                if (
                    table_name == 'dense_table'
                    or table_name == 'datanorm_table'
                ):
861 862 863 864 865 866 867
                    continue
                if type(configs[table_name]) != dict:
                    continue
                table_data = table_param.add()
                table_data.table_name = table_name
                set_sparse_table_config(table_data, configs[table_name])

868
    @property
869 870 871 872
    def amp(self):
        """
        Indicating whether we are using automatic mixed precision training
        Default Value: False
873

874
        Examples:
1
123malin 已提交
875

876
          .. code-block:: python
877

878
            import paddle.distributed.fleet as fleet
879 880
            strategy = fleet.DistributedStrategy()
            strategy.amp = True # by default this is false
881

882 883
        """
        return self.strategy.amp
884

885
    @amp.setter
886
    @is_strict_auto
887
    def amp(self, flag):
888
        if isinstance(flag, bool):
889
            self.strategy.amp = flag
890
        else:
891
            logger.warning("amp should have value of bool type")
892 893

    @property
894
    def amp_configs(self):
895
        """
896

897 898 899 900
        Set automatic mixed precision training configurations. In general, amp has serveral configurable
        settings that can be configured through a dict.

        **Notes**:
M
mapingshuo 已提交
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
            init_loss_scaling(float): The initial loss scaling factor. Default 32768.

            use_dynamic_loss_scaling(bool): Whether to use dynamic loss scaling. Default True.

            incr_every_n_steps(int): Increases loss scaling every n consecutive steps with finite gradients. Default 1000.

            decr_every_n_nan_or_inf(int): Decreases loss scaling every n accumulated steps with nan or inf gradients. Default 2.

            incr_ratio(float): The multiplier to use when increasing the loss scaling. Default 2.0.

            decr_ratio(float): The less-than-one-multiplier to use when decreasing the loss scaling. Default 0.5.

            custom_white_list(list[str]): Users' custom white list which always execution fp16.

            custom_black_list(list[str]): Users' custom black list which forbidden execution fp16.
916

917 918 919 920 921 922 923 924
            custom_black_varnames(list[str]): Users' custom black varibles' names.

            use_pure_fp16(bool): Whether to use the pure fp16 training. Default False.

            use_fp16_guard(bool): Whether to use `fp16_guard` when constructing the program.
                   Default True. Only takes effect when `use_pure_fp16` is turned on.

        Examples 1:
925
            .. code-block:: python
1
123malin 已提交
926

927 928 929 930 931 932
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.amp = True
                strategy.amp_configs = {
                    "init_loss_scaling": 32768,
                    "custom_white_list": ['conv2d']}
933 934

        Examples 2:
935 936 937 938 939 940 941 942 943 944
            .. code-block:: python

                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.amp = True
                # pure fp16
                strategy.amp_configs = {
                    "init_loss_scaling": 32768,
                    "use_pure_fp16": True
                }
945

946
        """
947
        return get_msg_dict(self.strategy.amp_configs)
948

949
    @amp_configs.setter
950
    @is_strict_auto
951 952 953
    def amp_configs(self, configs):
        check_configs_key(self.strategy.amp_configs, configs, "amp_configs")
        assign_configs_value(self.strategy.amp_configs, configs)
954

955 956 957
    @property
    def asp(self):
        """
958

959 960 961 962
        Indicating whether we are using automatic sparsity training
        Default Value: False

        Examples:
963
            .. code-block:: python
964

965 966 967
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.asp = True # by default this is false
968 969 970 971 972 973 974 975 976 977

        """
        return self.strategy.asp

    @asp.setter
    @is_strict_auto
    def asp(self, flag):
        if isinstance(flag, bool):
            self.strategy.asp = flag
        else:
978
            logger.warning("asp should have value of bool type")
979

980
    @property
981 982 983 984 985 986
    def recompute(self):
        """
        Indicating whether we are using forward recomputation for memory optimization
        Default value: False

        Examples:
987
            .. code-block:: python
1
123malin 已提交
988

989 990 991 992 993
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.recompute = True
                # suppose x and y are names of checkpoint tensors for recomputation
                strategy.recompute_configs = {"checkpoints": ["x", "y"]}
994 995 996

        """
        return self.strategy.recompute
997

998 999
    @property
    def sync_nccl_allreduce(self):
1000
        """
1001

1002 1003 1004 1005
        Indicating whether we are using synchronized all reduce in each communication thread
        We note that system overhead is usually lower when sync_nccl_allreduce = True

        Examples:
1006
            .. code-block:: python
1
123malin 已提交
1007

1008 1009 1010
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.sync_nccl_allreduce = True
1011 1012

        """
1013 1014 1015
        return self.strategy.sync_nccl_allreduce

    @sync_nccl_allreduce.setter
1016
    @is_strict_auto
1017 1018 1019 1020
    def sync_nccl_allreduce(self, flag):
        if isinstance(flag, bool):
            self.strategy.sync_nccl_allreduce = flag
        else:
1021
            logger.warning("sync_nccl_allreduce should have value of bool type")
1022

1023
    @property
1024
    def use_hierarchical_allreduce(self):
1025
        """
1026

1027 1028 1029 1030 1031
        Indicating whether we are using hierarchical allreduce in collective communication
        Hierarchical allreduce often does allreduce within a certain node group and then do
        allreduce among the leaders of each group

        Examples:
1032
            .. code-block:: python
1
123malin 已提交
1033

1034 1035 1036
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.use_hierarchical_allreduce = True
1037 1038

        """
1039
        return self.strategy.use_hierarchical_allreduce
1040

1041
    @use_hierarchical_allreduce.setter
1042
    @is_strict_auto
1043
    def use_hierarchical_allreduce(self, flag):
1044
        if isinstance(flag, bool):
1045
            self.strategy.use_hierarchical_allreduce = flag
1046
        else:
1047 1048
            logger.warning(
                "use_hierarchical_allreduce should have value of bool type"
1049 1050 1051
            )

    @property
1052
    def hierarchical_allreduce_inter_nranks(self):
1053
        """
1054

1055 1056 1057 1058
        Number of ranks for low level node groups in hierarchical allreduce
        Default value: number of GPU cards on each single GPU machine

        Example:
1059
            .. code-block:: python
1
123malin 已提交
1060

1061 1062 1063
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.hierarchical_allreduce_inter_nranks = 8
1064 1065

        """
1066
        return self.strategy.hierarchical_allreduce_inter_nranks
1067

1068
    @hierarchical_allreduce_inter_nranks.setter
1069
    @is_strict_auto
1070 1071 1072
    def hierarchical_allreduce_inter_nranks(self, value):
        if isinstance(value, int):
            self.strategy.hierarchical_allreduce_inter_nranks = value
1073
        else:
1074 1075
            logger.warning(
                "hierarchical_allreduce_inter_nranks should have value of int type"
1076 1077
            )

1078
    @property
1079
    def sync_batch_norm(self):
1080
        """
1081

1082
        Indicating whether we are using sync_batch_norm to do synchronous batch normalization among all training nodes.
1
123malin 已提交
1083

1084 1085 1086
        Default value: False

        Examples:
1087
            .. code-block:: python
1
123malin 已提交
1088

1089 1090 1091
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.sync_batch_norm = True
1092 1093 1094

        """

1095
        return self.strategy.sync_batch_norm
1096

1097
    @sync_batch_norm.setter
1098
    @is_strict_auto
1099
    def sync_batch_norm(self, flag):
1100
        if isinstance(flag, bool):
1101
            self.strategy.sync_batch_norm = flag
1102
        else:
1103
            logger.warning("sync_batch_norm should have value of bool type")
1104 1105 1106

    @property
    def fuse_all_reduce_ops(self):
1107
        """
1108

1109 1110 1111 1112
        Indicating whether we are using fuse_all_reduce_ops for gradient fusion during backward phase of training
        Default value: True

        Examples:
1113
            .. code-block:: python
1
123malin 已提交
1114

1115 1116 1117
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.fuse_all_reduce_ops = False
1118 1119

        """
1120 1121 1122
        return self.strategy.fuse_all_reduce_ops

    @fuse_all_reduce_ops.setter
1123
    @is_strict_auto
1124 1125 1126 1127
    def fuse_all_reduce_ops(self, flag):
        if isinstance(flag, bool):
            self.strategy.fuse_all_reduce_ops = flag
        else:
1128
            logger.warning("fuse_all_reduce_ops should have value of bool type")
1129

1130 1131
    @property
    def fuse_grad_size_in_MB(self):
1132
        """
1133

1134 1135 1136 1137 1138
        Specifying the size of gradient to fuse in Mega-Bytes

        Default value: 32

        Examples:
1139
            .. code-block:: python
1
123malin 已提交
1140

1141 1142 1143
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.fuse_grad_size_in_MB = 50
1
123malin 已提交
1144

1145
        """
1146 1147 1148
        return self.strategy.fuse_grad_size_in_MB

    @fuse_grad_size_in_MB.setter
1149
    @is_strict_auto
1150 1151 1152 1153
    def fuse_grad_size_in_MB(self, value):
        if isinstance(value, int):
            self.strategy.fuse_grad_size_in_MB = value
        else:
1154
            logger.warning("fuse_grad_size_in_MB should have value of int type")
1155

1156 1157 1158
    @property
    def last_comm_group_size_MB(self):
        """
1159

1160 1161 1162
        Specifying the size of gradient to fuse in Mega-Bytes when
        the last group of each batch communicates. Making the last group
        small is useful to improve performance.
1163 1164 1165 1166

        Default value: 1

        Examples:
1167 1168 1169 1170 1171
            .. code-block:: python

                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.last_comm_group_size_MB = 2
1172

1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
        """
        return self.strategy.last_comm_group_size_MB

    @last_comm_group_size_MB.setter
    @is_strict_auto
    def last_comm_group_size_MB(self, value):
        if value > 0:
            self.strategy.last_comm_group_size_MB = value
        else:
            raise ValueError("last_comm_group_size_MB should be greater than 0")

1184 1185 1186
    @property
    def find_unused_parameters(self):
        """
1187

1188
        Indicating whether we are using find_unused_parameters to
1189 1190
        find unused parameters in DataParallel.

1191
        Default value: False
1192 1193

        Examples:
1194
            .. code-block:: python
1195

1196 1197 1198
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.find_unused_parameters = True
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209

        """

        return self.strategy.find_unused_parameters

    @find_unused_parameters.setter
    @is_strict_auto
    def find_unused_parameters(self, flag):
        if isinstance(flag, bool):
            self.strategy.find_unused_parameters = flag
        else:
1210 1211
            logger.warning(
                "find_unused_parameters should have value of bool type"
1212
            )
1213

1214 1215 1216 1217 1218
    @property
    def _fuse_grad_size_in_TFLOPS(self):
        return self.strategy.fuse_grad_size_in_TFLOPS

    @_fuse_grad_size_in_TFLOPS.setter
1219
    @is_strict_auto
1220 1221 1222 1223
    def _fuse_grad_size_in_TFLOPS(self, value):
        if isinstance(value, float):
            self.strategy.fuse_grad_size_in_TFLOPS = value
        else:
1224 1225
            logger.warning(
                "fuse_grad_size_in_TFLOPS should have value of float type"
1226 1227
            )

1228
    @property
1229
    def nccl_comm_num(self):
1230
        """
1231

1232 1233 1234 1235 1236
        Specifying the number of NCCL communicator

        Default value: 1

        Examples:
1237
            .. code-block:: python
1
123malin 已提交
1238

1239 1240 1241
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.nccl_comm_num = 2
1
123malin 已提交
1242

1243 1244
        """

1245
        return self.strategy.nccl_comm_num
1246

1247
    @nccl_comm_num.setter
1248
    @is_strict_auto
1249
    def nccl_comm_num(self, value):
1250
        if isinstance(value, int):
1251
            self.strategy.nccl_comm_num = value
1252
        else:
1253
            logger.warning("nccl_comm_num should have value of int type")
1254

1255
    @recompute.setter
1256
    @is_strict_auto
1257
    def recompute(self, flag):
1258
        if isinstance(flag, bool):
1259
            self.strategy.recompute = flag
1260
        else:
1261
            logger.warning("recompute should have value of bool type")
1262 1263

    @property
1264 1265
    def recompute_configs(self):
        """
1266

1267 1268
        Set recompute configurations.

J
JZ-LIANG 已提交
1269 1270 1271 1272
        **Note**:
        checkpoints(list): list of string name of checkpoints. In general, the recompute
        strategy of current implementation should have some manually assign checkpoints.

1273
        enable_offload(bool): enable recompute checkpoints offload feature. this feature
J
JZ-LIANG 已提交
1274 1275 1276 1277 1278 1279
        will offload the checkpoint to host memory to allow even larger batch size. since
        the memcpy from host to device takes time, it is a trade off between larger batch
        size and training speed.

        checkpoint_shape(list): list of int that specific the shape of checkpoint. so far
        recompute-offload requires that all checkpoint to be same shape, and every dimension
1280
        specific here should be determined ("-1" is not allowed).
1281

1282
        Examples:
1283
            .. code-block:: python
1
123malin 已提交
1284

1285 1286 1287 1288 1289 1290 1291
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.recompute = True
                strategy.recompute_configs = {
                    "checkpoints": ["x", "y"],
                    "enable_offload": True,
                    "checkpoint_shape": [100, 512, 1024] }
1292 1293 1294 1295 1296

        """
        return get_msg_dict(self.strategy.recompute_configs)

    @recompute_configs.setter
1297
    @is_strict_auto
1298
    def recompute_configs(self, configs):
1299 1300 1301
        check_configs_key(
            self.strategy.recompute_configs, configs, "checkpoint_configs"
        )
1302
        assign_configs_value(self.strategy.recompute_configs, configs)
1303

1304 1305 1306
    @property
    def sharding(self):
        """
1307

1308
        Indicating whether we are using sharding Optimizer for memory
1309
        optimization. We implement the sharding optimizer following the ZeRO-DP
J
JZ-LIANG 已提交
1310 1311
        idea from [ZeRO: Memory Optimizations Toward Training Trillion Parameter Models](https://arxiv.org/abs/1910.02054).
        Model parameters and Optimizer State are sharded into different ranks allowing to fit larger model.
1312

1313 1314
        In Hybrid parallelism scenario, we use sharding config as uniform API to set each parallelism.

1315 1316 1317
        Default value: False

        Examples:
1318
            .. code-block:: python
1
123malin 已提交
1319

1320 1321 1322
                import paddle.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.sharding = True
1
123malin 已提交
1323

1324 1325 1326 1327 1328 1329 1330 1331 1332
        """
        return self.strategy.sharding

    @sharding.setter
    @is_strict_auto
    def sharding(self, flag):
        if isinstance(flag, bool):
            self.strategy.sharding = flag
        else:
1333
            logger.warning("sharding should have value of bool type")
1334 1335 1336 1337

    @property
    def sharding_configs(self):
        """
1338

1339
        Set sharding configurations.
1340 1341

        **Note**:
1342 1343
            sharding_segment_strategy(string, optional): strategy used to segment the program(forward & backward operations). two strategise are
            available: "segment_broadcast_MB" and "segment_anchors". segment is a concept used in sharding to overlap computation and
1344 1345
            communication. Default is segment_broadcast_MB.

1346
            segment_broadcast_MB(float, optional): segment by the parameters broadcast volume. sharding will introduce parameter broadcast operations into program, and
1347 1348 1349 1350
            after every segment_broadcast_MB size parameter being broadcasted, the program will be cutted into one segment.
            This configuration will affect the communication speed in sharding training, and should be an empirical value decided by your model size and network topology.
            Only enable when sharding_segment_strategy = segment_broadcast_MB. Default is 32.0 .

1351
            segment_anchors(list): list of anchors used to segment the program, which allows a finner control of program segmentation.
1352 1353 1354 1355 1356 1357
            this strategy is experimental by now. Only enable when sharding_segment_strategy = segment_anchors.

            sharding_degree(int, optional): specific the number of gpus within each sharding parallelism group; and sharding will be turn off if sharding_degree=1.  Default is 8.

            gradient_merge_acc_step(int, optional): specific the accumulation steps in gradient merge; and gradient merge will be turn off if gradient_merge_acc_step=1.  Default is 1.

1358
            optimize_offload(bool, optional): enable the optimizer offload which will offload the moment vars to Host memory in order to saving GPU memory for fitting larger model.
1359 1360 1361 1362 1363
            the moment var will be prefetch from and offloaded to Host memory during update stage. it is a stragtegy that trades off between training speed and GPU memory, and is recommened to be turn on only when gradient_merge_acc_step large, where
            the number of time of update stage will be relatively small compared with forward&backward's.  Default is False.

            dp_degree(int, optional): specific the number of data parallelism group; when dp_degree >= 2, it will introduce dp_degree ways data parallelism as the outer parallelsim for the inner parallelsim. User is responsible to ensure global_world_size = mp_degree * sharding_degree * pp_degree * dp_degree. Default is 1.

1364
            mp_degree(int, optional): [Hybrid parallelism ONLY] specific the number of gpus within each megatron parallelism group; and megatron parallelism will turn be off if mp_degree=1.  Default is 1.
1365

1366
            pp_degree(int, optional): [Hybrid parallelism ONLY] specific the number of gpus within each pipeline parallelism group; and pipeline parallelism will turn be off if pp_degree=1.  Default is 1.
1367

1368
            pp_allreduce_in_optimize(bool, optional): [Hybrid parallelism ONLY] move the allreduce operations from backward stage to update(optimize) stage when pipeline parallelsim is on.
1369
            This configuration will affect the communication speed of Hybrid parallelism training depeneded on network topology. this strategy is experimental by now..  Default is False.
J
JZ-LIANG 已提交
1370

1371 1372 1373
            optimize_cast(bool, optional): [Hybrid parallelism ONLY] Move the cast op of AMP which cast fp32 param to fp16 param to optimizer. optimize_cast will persist fp16 param, it
            will take more memory, but will be faster, trade space for time. Recommend to turn on only when using pipeline or gradient_merge_acc_step large.

J
JZ-LIANG 已提交
1374

1375
        Examples:
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388
            .. code-block:: python

                # sharding-DP, 2 nodes with 8 gpus per node
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.sharding = True
                strategy.sharding_configs = {
                    "sharding_segment_strategy": "segment_broadcast_MB",
                    "segment_broadcast_MB": 32,
                    "sharding_degree": 8,
                    "dp_degree": 2,
                    "gradient_merge_acc_step": 4,
                    }
1
123malin 已提交
1389

1390 1391 1392 1393 1394 1395
        """
        return get_msg_dict(self.strategy.sharding_configs)

    @sharding_configs.setter
    @is_strict_auto
    def sharding_configs(self, configs):
1396 1397 1398
        check_configs_key(
            self.strategy.sharding_configs, configs, "sharding_configs"
        )
1399 1400
        assign_configs_value(self.strategy.sharding_configs, configs)

1401 1402 1403
    @property
    def without_graph_optimization(self):
        """
1404

1405 1406 1407
        Run program using Executor other than ParallelExecutor.

        Examples:
1408
            .. code-block:: python
1409

1410 1411 1412
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.without_graph_optimization = True
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422

        """
        return self.strategy.without_graph_optimization

    @without_graph_optimization.setter
    @is_strict_auto
    def without_graph_optimization(self, flag):
        if isinstance(flag, bool):
            self.strategy.without_graph_optimization = flag
        else:
1423 1424
            logger.warning(
                "without_graph_optimization should have value of bool type"
1425 1426
            )

1427 1428 1429
    @property
    def _calc_comm_same_stream(self):
        """
1430

1431 1432 1433
        This based on raw_program_optimizer program
        Set whether use same stream for calc and comm when fuse allreduce
        The default value for the calc_comm_same_stream is False
1434

1435
        Examples:
1436 1437 1438 1439 1440 1441
            .. code-block:: python

                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.calc_comm_same_stream = True

1442 1443 1444 1445 1446 1447 1448 1449 1450
        """
        return self.strategy.calc_comm_same_stream

    @_calc_comm_same_stream.setter
    @is_strict_auto
    def _calc_comm_same_stream(self, same):
        if isinstance(same, bool):
            self.strategy.calc_comm_same_stream = same
        else:
1451 1452
            logger.warning(
                "calc_comm_same_stream should have value of boolean type"
1453 1454
            )

1455 1456 1457
    @property
    def fuse_grad_merge(self):
        """
1458

1459 1460 1461
        Set whether fuse the grad for gradient merge.
        Note: this flag will only effect the gradient merge under pipeline mode
        The default value for the fuse_grad_merge is False
1462

1463
        Examples:
1464 1465 1466 1467 1468 1469
            .. code-block:: python

                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.fuse_param_grad = True

1470 1471 1472 1473 1474 1475 1476 1477 1478
        """
        return self.strategy.fuse_grad_merge

    @fuse_grad_merge.setter
    @is_strict_auto
    def fuse_grad_merge(self, fuse_grad_merge):
        if isinstance(fuse_grad_merge, bool):
            self.strategy.fuse_grad_merge = fuse_grad_merge
        else:
1479
            logger.warning("fuse_grad_merge should have value of boolean type")
1480

1481 1482 1483
    @property
    def fuse_grad_size_in_num(self):
        """
1484

1485
        This based on raw_program_optimizer program and allreduce the num of the fused op
1486

1487
        Examples:
1488 1489 1490 1491 1492 1493 1494
            .. code-block:: python

                import paddle.distributed.fleet as fleet

                strategy = fleet.DistributedStrategy()
                strategy.fuse_grad_size_in_num = 2

1495 1496 1497 1498 1499 1500 1501 1502 1503
        """
        return self.strategy.fuse_grad_size_in_num

    @fuse_grad_size_in_num.setter
    @is_strict_auto
    def fuse_grad_size_in_num(self, num):
        if isinstance(num, int):
            self.strategy.fuse_grad_size_in_num = num
        else:
1504 1505
            logger.warning(
                "fuse_grad_size_in_num should have value of int32 type"
1506
            )
1507

1508
    @property
1509 1510
    def pipeline(self):
        """
1511

1512 1513 1514 1515 1516 1517
        Indicating whether we are using pipeline parallelism for distributed training.
        Current implementation mainly focus on single GPU machine pipeline parallelism and
        data parallelism across GPU machine. The pipeline information is indicated through
        device_guard information in user-defined program.

        Examples:
1518
            .. code-block:: python
1
123malin 已提交
1519

1520 1521 1522
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.pipeline = True
1523 1524 1525

        """
        return self.strategy.pipeline
1526

1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
    @property
    def is_fl_ps_mode(self):
        return self.strategy.is_fl_ps_mode

    @is_fl_ps_mode.setter
    @is_strict_auto
    def is_fl_ps_mode(self, flag):
        if isinstance(flag, bool):
            self.strategy.is_fl_ps_mode = flag
        else:
1537
            logger.warning("is_fl_ps_mode should have value of bool type")
1538

1539 1540 1541 1542 1543 1544 1545 1546 1547 1548
    @property
    def is_with_coordinator(self):
        return self.strategy.with_coordinator

    @is_with_coordinator.setter
    @is_strict_auto
    def is_with_coordinator(self, flag):
        if isinstance(flag, bool):
            self.strategy.with_coordinator = flag
        else:
1549
            logger.warning("with_coordinator should have value of bool type")
1550

1551
    @pipeline.setter
1552
    @is_strict_auto
1553
    def pipeline(self, flag):
1554
        if isinstance(flag, bool):
1555
            self.strategy.pipeline = flag
1556
        else:
1557
            logger.warning("pipeline should have value of bool type")
1558 1559

    @property
1560 1561
    def pipeline_configs(self):
        """
1562

1563 1564
        Set pipeline parallelism configurations. In pipeline parallelism,
        different parts of neural networks are running on different GPUS.
1565
        There are Tensor queue buffer between each pair of neighborhood GPUS
1566 1567 1568
        that are responsible for synchronizing hidden Tensor results between
        GPUs. Pipeline parallelism consists of serveral producer-consumer style
        hardware pairs, such as GPU-GPU, CPU-GPU, GPU-XPU. The best way to speedup
1569
        pipeline parallelism is to make the size of Tensor in Tensor queue smaller,
1570
        so that we will have a faster producer for downstream consumers.
1571

1572 1573
        **Notes**:
            **Detailed arguments for pipeline_configs**
M
mapingshuo 已提交
1574

1575
            **micro_batch_size**: the number of small batches in each user defined batch
1576

1577
        Examples:
1578
            .. code-block:: python
1
123malin 已提交
1579

1580 1581 1582 1583
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.pipeline = True
                strategy.pipeline_configs = {"micro_batch_size": 12}
1584

1585
        """
1586

1587
        return get_msg_dict(self.strategy.pipeline_configs)
1588

1589
    @pipeline_configs.setter
1590
    @is_strict_auto
1591
    def pipeline_configs(self, configs):
1592 1593 1594
        check_configs_key(
            self.strategy.pipeline_configs, configs, "pipeline_configs"
        )
1595
        assign_configs_value(self.strategy.pipeline_configs, configs)
1596

L
lilong12 已提交
1597 1598 1599
    @property
    def tensor_parallel(self):
        """
1600

L
lilong12 已提交
1601 1602 1603
        Indicating whether we are using tensor parallel for distributed training.

        Examples:
1604
            .. code-block:: python
L
lilong12 已提交
1605

1606 1607 1608
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.tensor_parallel = True
L
lilong12 已提交
1609 1610 1611 1612 1613 1614 1615 1616 1617 1618

        """
        return self.strategy.tensor_parallel

    @tensor_parallel.setter
    @is_strict_auto
    def tensor_parallel(self, flag):
        if isinstance(flag, bool):
            self.strategy.tensor_parallel = flag
        else:
1619
            logger.warning("tensor_parallel should have value of bool type")
L
lilong12 已提交
1620 1621 1622 1623

    @property
    def tensor_parallel_configs(self):
        """
1624

L
lilong12 已提交
1625 1626 1627 1628
        Set tensor_parallel configurations.

        **Notes**:
            **Detailed arguments for tensor_parallel_configs**
1629

L
lilong12 已提交
1630
            **tensor_parallel_degree**: degree of tensor parallel
1631

1632 1633
            **tensor_init_seed**: parameter initialization random seed

L
lilong12 已提交
1634 1635

        Examples:
1636
            .. code-block:: python
L
lilong12 已提交
1637

1638 1639 1640 1641 1642
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.tensor_parallel = True
                strategy.tensor_parallel_configs = {"tensor_parallel_degree": 4,
                                                    "tensor_init_seed": 123}
L
lilong12 已提交
1643 1644 1645 1646 1647 1648 1649

        """
        return get_msg_dict(self.strategy.tensor_parallel_configs)

    @tensor_parallel_configs.setter
    @is_strict_auto
    def tensor_parallel_configs(self, configs):
1650 1651 1652 1653 1654
        check_configs_key(
            self.strategy.tensor_parallel_configs,
            configs,
            "tensor_parallel_configs",
        )
L
lilong12 已提交
1655 1656
        assign_configs_value(self.strategy.tensor_parallel_configs, configs)

1657 1658 1659
    @property
    def hybrid_configs(self):
        """
1660

1661
        Dynamic graph hybrid parallel strategy configuration. Three-way hybrid parallelism
1662 1663 1664 1665 1666
        needs to meet the following relationships

        total_number_GPUs = dp_degree * mp_degree * pp_degree

        **Note**:
1667
            **dp_degree(int)**: set number of GPUs in a data parallel group. Default -1.
1668
                                    This value should be an integer greater than 0.
1669
                                    If it is not set, or set to -1, its value will be inferred
1670 1671
                                    based on the total number of cards.

1672 1673 1674
            **mp_degree(int)**: set number of GPUs in a model parallel group. Default 1

            **pp_degree(int)**: set number of GPUs in a pipeline parallel group. Default 1
1675

1676 1677
            **order(list(string))**: set hybrid parallel dimensions, the order is from outside to inside. Default ['dp','pp','sharding','mp']

1678
        Examples:
1679 1680 1681 1682 1683 1684 1685
            .. code-block:: python

                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.hybrid_configs = {
                    "dp_degree": 1,
                    "mp_degree": 2,
1686 1687
                    "pp_degree": 1,
                    "order":['dp','pp','sharding','mp']}
1688

1689 1690 1691 1692 1693
        """
        return get_msg_dict(self.strategy.hybrid_configs)

    @hybrid_configs.setter
    def hybrid_configs(self, configs):
1694 1695 1696
        check_configs_key(
            self.strategy.hybrid_configs, configs, "hybrid_configs"
        )
1697 1698
        assign_configs_value(self.strategy.hybrid_configs, configs)

1699
    @property
1700
    def localsgd(self):
1701
        """
1702

M
mapingshuo 已提交
1703 1704 1705
        Indicating whether we are using Local SGD training. Default Value: False
        For more details, please refer to
        `Don't Use Large Mini-Batches, Use Local SGD <https://arxiv.org/pdf/1808.07217.pdf>`_.
1706 1707 1708


        Examples:
1709
            .. code-block:: python
1
123malin 已提交
1710

1711 1712 1713
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.localsgd = True # by default this is false
1714 1715

        """
1716
        return self.strategy.localsgd
1717

1718
    @localsgd.setter
1719
    @is_strict_auto
1720 1721 1722
    def localsgd(self, flag):
        if isinstance(flag, bool):
            self.strategy.localsgd = flag
1723
        else:
1724
            logger.warning("localsgd should have value of bool type")
1725 1726

    @property
1727
    def localsgd_configs(self):
1728
        """
1729

1730 1731 1732 1733
        Set LocalSGD training configurations. LocalSGD has a configurable
        setting that can be configured through a dict.

        **Notes**:
M
mapingshuo 已提交
1734
            k_steps(int) The local steps for training before parameter synchronization. Default 1.
1735
            begin_step(int) The step of beginning training by localsgd. Default 1.
1736 1737

        Examples:
1738
            .. code-block:: python
1
123malin 已提交
1739

1740 1741 1742 1743 1744
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.localsgd = True
                strategy.localsgd_configs = {"k_steps": 4,
                                            "begin_step": 30}
1745 1746 1747

        """

1748
        return get_msg_dict(self.strategy.localsgd_configs)
1749

1750
    @localsgd_configs.setter
1751
    @is_strict_auto
1752
    def localsgd_configs(self, configs):
1753 1754 1755
        check_configs_key(
            self.strategy.localsgd_configs, configs, "localsgd_configs"
        )
1756
        assign_configs_value(self.strategy.localsgd_configs, configs)
1757

1758 1759 1760
    @property
    def adaptive_localsgd(self):
        """
1761

1762
        Indicating whether we are using Adaptive Local SGD training. Default Value: False
1763
        For more details, please refer to `Adaptive Communication Strategies to Achieve
1764 1765 1766
        the Best Error-Runtime Trade-off in Local-Update SGD <https://arxiv.org/pdf/1810.08313.pdf>`_.

        Examples:
1767
            .. code-block:: python
1
123malin 已提交
1768

1769 1770 1771
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.adaptive_localsgd = True # by default this is false
1772 1773

        """
1774
        return self.strategy.adaptive_localsgd
1775 1776 1777 1778 1779

    @adaptive_localsgd.setter
    @is_strict_auto
    def adaptive_localsgd(self, flag):
        if isinstance(flag, bool):
1780
            self.strategy.adaptive_localsgd = flag
1781
        else:
1782
            logger.warning("adaptive_localsgd should have value of bool type")
1783 1784 1785 1786

    @property
    def adaptive_localsgd_configs(self):
        """
1787

1788 1789 1790 1791 1792 1793 1794
        Set AdaptiveLocalSGD training configurations. AdaptiveLocalSGD has a configurable
        setting that can be configured through a dict.

        **Notes**:
            init_k_steps(int) The initial steps for training before adaptive localsgd.
                              Then, the adaptive localsgd method will modify init_k_steps automatically.
                              Default 1.
1795

1796
            begin_step(int) The step of beginning training by adaptive localsgd. Default 1.
1797 1798

        Examples:
1799
            .. code-block:: python
1
123malin 已提交
1800

1801 1802 1803 1804 1805
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.adaptive_localsgd = True
                strategy.adaptive_localsgd_configs = {"init_k_steps": 1,
                                                    "begin_step": 30}
1806 1807 1808 1809 1810 1811 1812 1813

        """

        return get_msg_dict(self.strategy.adaptive_localsgd_configs)

    @adaptive_localsgd_configs.setter
    @is_strict_auto
    def adaptive_localsgd_configs(self, configs):
1814 1815 1816 1817 1818
        check_configs_key(
            self.strategy.adaptive_localsgd_configs,
            configs,
            "adaptive_localsgd_configs",
        )
1819 1820
        assign_configs_value(self.strategy.adaptive_localsgd_configs, configs)

1821
    @property
1822
    def dgc(self):
1823
        """
1824

1825 1826 1827 1828 1829 1830
        Indicating whether we are using Deep Gradient Compression training. For more details, please refer to
        [Deep Gradient Compression](https://arxiv.org/abs/1712.01887).

        Default Value: False

        Examples:
1831
            .. code-block:: python
1
123malin 已提交
1832

1833 1834 1835
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.dgc = True # by default this is false
1836 1837

        """
1838
        return self.strategy.dgc
1839

1840
    @dgc.setter
1841
    @is_strict_auto
1842 1843 1844
    def dgc(self, flag):
        if isinstance(flag, bool):
            self.strategy.dgc = flag
1845
        else:
1846
            logger.warning("dgc should have value of bool type")
1847 1848

    @property
1849
    def dgc_configs(self):
1850
        r"""
1851

1852 1853 1854 1855
        Set Deep Gradient Compression training configurations. In general, dgc has serveral configurable
        settings that can be configured through a dict.

        **Notes**:
M
mapingshuo 已提交
1856 1857 1858 1859 1860 1861 1862 1863 1864 1865
            rampup_begin_step(int): The beginning step from which gradient compression is implemented. Default 0.

            rampup_step(int): Time steps used in sparsity warm-up periods. Default is 1. \
                    For example, if the sparsity is [0.75, 0.9375, 0.984375, 0.996, 0.999], and the rampup_step is 100, \
                    it will use 0.75 at 0~19 steps, and 0.9375 at 20~39 steps, and so on. And when reach sparsity array \
                    ends, it will use 0.999 then and after.

            sparsity(list[float]): Get top important element from gradient tensor, the ratio is (1 - sparsity). \
                    Default is [0.999]. For example, if the sparsity is [0.99, 0.999], the top [1%, 0.1%] important \
                    element will be transmitted.
1866 1867

        Examples:
1868
            .. code-block:: python
1
123malin 已提交
1869

1870 1871 1872 1873
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.dgc = True
                strategy.dgc_configs = {"rampup_begin_step": 1252}
1874 1875

        """
1876
        return get_msg_dict(self.strategy.dgc_configs)
1877

1878
    @dgc_configs.setter
1879
    @is_strict_auto
1880 1881 1882
    def dgc_configs(self, configs):
        check_configs_key(self.strategy.dgc_configs, configs, "dgc_configs")
        assign_configs_value(self.strategy.dgc_configs, configs)
1883

1884 1885 1886
    @property
    def fp16_allreduce(self):
        """
1887

1888 1889 1890 1891
        Indicating whether we are using fp16 gradient allreduce training
        Default Value: False

        Examples:
1892
            .. code-block:: python
1
123malin 已提交
1893

1894
                import paddle.distributed.fleet as fleet
1895

1896 1897
                strategy = fleet.DistributedStrategy()
                strategy.fp16_allreduce = True # by default this is false
1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908

        """
        return self.strategy.fp16_allreduce

    @fp16_allreduce.setter
    @is_strict_auto
    def fp16_allreduce(self, flag):
        if not isinstance(flag, bool):
            raise TypeError('fp16_allreduce must be value of bool type')
        self.strategy.fp16_allreduce = flag

1909
    @property
1910
    def gradient_merge(self):
1911
        """
1912

1913 1914 1915 1916 1917 1918 1919 1920 1921 1922
        Gradient Merge, also called as Gradient Accumulation,
        is a strategy for large batch training. With this strategy,
        model parameter will not be updated until user-defined steps.
        For each step, the forward network and the backward network
        will run to calculate the gradient of model parameters.
        For every k step, the optimization network will run,
        applying a specific optimization method (such as SGD, Adam)
        to model parameters.

        Examples:
1923
            .. code-block:: python
1
123malin 已提交
1924

1925 1926 1927 1928
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.gradient_merge = True
                strategy.gradient_merge_configs = {"k_steps": 4, "avg": True}
M
mapingshuo 已提交
1929

1930
        """
1931
        return self.strategy.gradient_merge
1932

1933
    @gradient_merge.setter
1934
    @is_strict_auto
1935
    def gradient_merge(self, flag):
1936
        if isinstance(flag, bool):
1937
            self.strategy.gradient_merge = flag
1938
        else:
1939
            logger.warning("gradient_merge should have value of bool type")
1940 1941 1942

    @property
    def gradient_merge_configs(self):
1943
        """
1944

1945
        the key-value configs of distribute_strategy
M
mapingshuo 已提交
1946 1947 1948 1949 1950 1951 1952

        **Note**:
            k_steps(int): the update period of the parameters.

            avg(bool): whether to average the gradients of each mini-batch, the default value is `True`

        Examples:
1953
            .. code-block:: python
1
123malin 已提交
1954

1955 1956 1957 1958
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.gradient_merge = True
                strategy.gradient_merge_configs = {"k_steps": 4, "avg": True}
M
mapingshuo 已提交
1959

1960
        """
1961 1962 1963
        return get_msg_dict(self.strategy.gradient_merge_configs)

    @gradient_merge_configs.setter
1964
    @is_strict_auto
1965
    def gradient_merge_configs(self, configs):
1966 1967 1968
        check_configs_key(
            self.strategy.gradient_merge_configs, configs, "gradient_configs"
        )
1969
        assign_configs_value(self.strategy.gradient_merge_configs, configs)
1970 1971

    @property
1972
    def lars(self):
1973
        """
1974

1975 1976
        Set lars configurations. lars is used to deal with the convergence problems when the global
        batch size is larger than 8k.  For more details, please refer to
1977 1978 1979 1980 1981
        [Large Batch Training of Convolutional Networks](https://arxiv.org/abs/1708.03888).

        Default Value: False

        Examples:
1982
            .. code-block:: python
1
123malin 已提交
1983

1984 1985 1986
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.lars = True # by default this is false
1987 1988

        """
1989
        return self.strategy.lars
1990

1991
    @lars.setter
1992
    @is_strict_auto
1993
    def lars(self, flag):
1994
        if isinstance(flag, bool):
1995
            self.strategy.lars = flag
1996
        else:
1997
            logger.warning("lars should have value of bool type")
1998

1999 2000
    @property
    def lars_configs(self):
2001
        """
2002

2003 2004 2005 2006 2007
        Set Lars training configurations.

        **Notes**:
        **lars_coeff (float)**: trust ratio in lars formula.
        **lars_weight_decay** (float): weight decay coefficient in lars formula.
2008 2009
        **epsilon (float)**: argument is used to avoid potential devision-by-zero
        when compute the local lr;
2010 2011 2012 2013
        **exclude_from_weight_decay ([string])**: is a list of name strings of layers which
        will be exclude from weight decay in lars formula.

        Examples:
2014
            .. code-block:: python
1
123malin 已提交
2015

2016 2017 2018 2019 2020 2021 2022 2023 2024
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.lars = True
                strategy.lars_configs = {
                            "lars_coeff": 0.01,
                            "lars_weight_decay": 0.0005,
                            "epsilon": 0,
                            "exclude_from_weight_decay": ['batch_norm', '.b_0']
                        }
M
mapingshuo 已提交
2025

2026
        """
2027 2028 2029
        return get_msg_dict(self.strategy.lars_configs)

    @lars_configs.setter
2030
    @is_strict_auto
2031 2032 2033 2034
    def lars_configs(self, configs):
        check_configs_key(self.strategy.lars_configs, configs, "lars_configs")
        assign_configs_value(self.strategy.lars_configs, configs)

2035
    @property
2036
    def lamb(self):
2037
        """
2038

2039 2040 2041
        Set lamb configurations. lamb is used to deal with the convergence problems for large
        batch size training, specially for attention-related model like BERT. For more details,
        please refer to
2042 2043 2044
        [Large Batch Optimization for Deep Learning: Training BERT in 76 minutes](https://arxiv.org/abs/1904.00962).

        Default Value: False
1
123malin 已提交
2045

2046
        Examples:
2047
            .. code-block:: python
1
123malin 已提交
2048

2049 2050 2051
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.lamb = True # by default this is false
2052 2053 2054

        """

2055
        return self.strategy.lamb
2056

2057
    @lamb.setter
2058
    @is_strict_auto
2059
    def lamb(self, flag):
2060
        if isinstance(flag, bool):
2061
            self.strategy.lamb = flag
2062
        else:
2063
            logger.warning("lamb should have value of bool type")
2064

2065 2066
    @property
    def lamb_configs(self):
2067
        """
2068

2069 2070 2071 2072 2073 2074 2075 2076
        Set Lars training configurations.

        **Notes**:
        **lamb_weight_decay** (float): weight decay coefficient in lamb formula.
        **exclude_from_weight_decay ([string])**: is a list of name strings of layers which
        will be exclude from weight decay in lamb formula.

        Examples:
2077 2078 2079 2080 2081 2082 2083 2084 2085
            .. code-block:: python

                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.lamb = True
                strategy.lamb_configs = {
                        'lamb_weight_decay': 0.01,
                        'exclude_from_weight_decay': [],
                    }
1
123malin 已提交
2086

2087
        """
2088 2089 2090
        return get_msg_dict(self.strategy.lamb_configs)

    @lamb_configs.setter
2091
    @is_strict_auto
2092 2093 2094 2095
    def lamb_configs(self, configs):
        check_configs_key(self.strategy.lamb_configs, configs, "lamb_configs")
        assign_configs_value(self.strategy.lamb_configs, configs)

2096 2097
    @property
    def elastic(self):
2098
        """
2099

2100 2101
        Indicating whether we want to do current distributed training on clusters with elastic resources.
        Currently, this is configuration is not valid.
2102

2103
        """
2104 2105 2106
        return self.strategy.elastic

    @elastic.setter
2107
    @is_strict_auto
2108 2109 2110 2111
    def elastic(self, flag):
        if isinstance(flag, bool):
            self.strategy.elastic = flag
        else:
2112
            logger.warning("elastic should have value of bool type")
2113 2114 2115

    @property
    def auto(self):
2116
        """
2117

2118
        Indicating whether we are using auto-parallel configuration
2119
        This feature is currently an experimental feature. Currently,
2120 2121 2122 2123 2124 2125
        auto-parallelism can be used only when a user does not set any other
        strategy configs except auto. For details, please reference the following
        code example
        Default Value: False

        Examples:
2126
            .. code-block:: python
1
123malin 已提交
2127

2128 2129 2130
                import paddle
                paddle.enable_static()
                import paddle.distributed.fleet as fleet
2131

2132 2133 2134 2135
                strategy = fleet.DistributedStrategy()
                strategy.auto = True
                # if set other strategy at the same time, auto will not apply
                # strategy.amp = True
2136

2137 2138
                optimizer = paddle.optimizer.SGD(learning_rate=0.01)
                optimizer = fleet.distributed_optimizer(optimizer, strategy)
2139 2140

        """
2141 2142 2143 2144 2145 2146 2147
        return self.strategy.auto

    @auto.setter
    def auto(self, flag):
        if isinstance(flag, bool):
            self.strategy.auto = flag
        else:
2148
            logger.warning("auto should have value of bool type")
2149

2150 2151 2152
    @property
    def semi_auto(self):
        """
2153

2154
        Indicating whether we are using semi-auto parallel function
2155
        This feature is currently an experimental feature. Currently,
2156 2157 2158 2159 2160 2161
        auto-parallelism can be used only when a user does not set any other
        strategy configs except semi-auto. For details, please reference the following
        code example
        Default Value: False

        Examples:
2162
            .. code-block:: python
2163

2164 2165 2166
                import paddle
                paddle.enable_static()
                import paddle.distributed.fleet as fleet
2167

2168 2169 2170 2171
                strategy = fleet.DistributedStrategy()
                strategy.semi_auto = True
                # if set other strategy at the same time, auto will not apply
                # strategy.amp = True
2172

2173 2174
                optimizer = paddle.optimizer.SGD(learning_rate=0.01)
                optimizer = fleet.distributed_optimizer(optimizer, strategy)
2175 2176 2177 2178 2179 2180 2181 2182 2183

        """
        return self.strategy.semi_auto

    @semi_auto.setter
    def semi_auto(self, flag):
        if isinstance(flag, bool):
            self.strategy.semi_auto = flag
        else:
2184
            logger.warning("semi-auto should have value of bool type")
2185

Z
zhaoyingli 已提交
2186 2187 2188
    @property
    def auto_search(self):
        """
2189

Z
zhaoyingli 已提交
2190 2191 2192
        Indicating whether we are using auto-search parallel function
        For details, please reference the following code example
        Default Value: False
2193

Z
zhaoyingli 已提交
2194
        Examples:
2195 2196 2197 2198 2199 2200 2201 2202 2203
            .. code-block:: python

                import paddle

                paddle.enable_static()
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.auto_search = True

Z
zhaoyingli 已提交
2204 2205 2206 2207 2208 2209 2210 2211
        """
        return self.strategy.auto_search

    @auto_search.setter
    def auto_search(self, flag):
        if isinstance(flag, bool):
            self.strategy.auto_search = flag
        else:
2212
            logger.warning("auto-search should have value of bool type")
Z
zhaoyingli 已提交
2213

2214 2215 2216
    @property
    def split_data(self):
        """
2217

2218 2219
        Indicating whether we split the data. If True, we split the data.
        Default Value: True
2220

2221
        Examples:
2222 2223 2224 2225 2226 2227 2228 2229 2230
            .. code-block:: python

                import paddle

                paddle.enable_static()
                import paddle.distributed.fleet as fleet
                strategy = fleet.DistributedStrategy()
                strategy.split_data = True

2231 2232 2233 2234 2235 2236 2237 2238
        """
        return self.strategy.split_data

    @split_data.setter
    def split_data(self, flag):
        if isinstance(flag, bool):
            self.strategy.split_data = flag
        else:
2239
            logger.warning("split_data should have value of bool type")
2240

2241 2242 2243
    @property
    def qat(self):
        """
2244

2245 2246
        Indicating whether we are using quantization training
        Default Value: False
2247

2248 2249 2250 2251 2252 2253 2254 2255
        """
        return self.strategy.qat

    @qat.setter
    def qat(self, flag):
        if isinstance(flag, bool):
            self.strategy.qat = flag
        else:
2256
            logger.warning("qat should have value of bool type")
2257 2258 2259 2260

    @property
    def qat_configs(self):
        """
2261

2262 2263 2264 2265 2266 2267 2268 2269 2270 2271
        Set quantization training configurations. In general, qat has serveral configurable
        settings that can be configured through a dict.

        **Notes**:
            channel_wise_abs_max(bool): Whether to use `per_channel` quantization training. Default is True.

            weight_bits(int): quantization bit number for weight. Default is 8.

            activation_bits(int): quantization bit number for activation. Default is 8.

2272
            not_quant_pattern(list[str]): When the skip pattern is detected in an op's name scope,
2273 2274 2275 2276 2277
                the corresponding op will not be quantized.

            algo(str): Other quantization training algorithm.

        Exampless:
2278
            .. code-block:: python
2279

2280
                import paddle.distributed.fleet as fleet
2281

2282 2283 2284 2285 2286 2287 2288
                strategy = fleet.DistributedStrategy()
                strategy.qat = True
                strategy.qat_configs = {
                    "channel_wise_abs_max": True,
                    "weight_bits": 8,
                    "activation_bits: 8,
                    "not_quant_pattern": ['skip_quant']}
2289 2290 2291 2292 2293 2294 2295 2296 2297

        """
        return get_msg_dict(self.strategy.qat_configs)

    @qat_configs.setter
    def qat_configs(self, configs):
        check_configs_key(self.strategy.qat_configs, configs, "qat_configs")
        assign_configs_value(self.strategy.qat_configs, configs)

K
kuizhiqing 已提交
2298 2299 2300
    @property
    def heter_ccl_mode(self):
        """
2301

K
kuizhiqing 已提交
2302 2303 2304 2305 2306 2307
        Indicating whether we are using heter_ccl_mode for model training.
        This feature is currently an experimental feature. Currently,
        heter_ccl_mode can be used only for dataparallel with dygraph mode.
        Default Value: False

        Examples:
2308
            .. code-block:: python
K
kuizhiqing 已提交
2309

2310 2311
                import paddle
                import paddle.distributed.fleet as fleet
K
kuizhiqing 已提交
2312

2313 2314
                strategy = fleet.DistributedStrategy()
                strategy.heter_ccl_mode = True
K
kuizhiqing 已提交
2315

2316 2317 2318
                # for initialize parallel env, only need to call
                paddle.distributed.init_parallel_env()
                # then the heterogenous context will be created.
K
kuizhiqing 已提交
2319 2320 2321 2322 2323 2324 2325 2326 2327

        """
        return self.strategy.heter_ccl_mode

    @heter_ccl_mode.setter
    def heter_ccl_mode(self, flag):
        if isinstance(flag, bool):
            self.strategy.heter_ccl_mode = flag
        else:
2328
            logger.warning("heter_ccl_mode should have value of bool type")
K
kuizhiqing 已提交
2329

2330 2331
    @property
    def cudnn_exhaustive_search(self):
2332
        """
2333

2334 2335 2336 2337 2338 2339 2340
        Indicating whether to use exhaustive search method to choose convolution algorithms.
        Exhaustive search attempts all cuDNN algorithms to choose the fastest algorithm.
        This method is time-consuming, the choosed algorithm will be cached for the given layer specifications.
        Once the layer specifications (like batch size, feature map size) are changed, it will search again.
        Default Value: True

        Examples:
2341
            .. code-block:: python
1
123malin 已提交
2342

2343 2344 2345
                import paddle
                paddle.enable_static()
                import paddle.distributed.fleet as fleet
2346

2347 2348 2349 2350 2351
                strategy = fleet.DistributedStrategy()
                strategy.cudnn_exhaustive_search = False

                optimizer = paddle.optimizer.SGD(learning_rate=0.01)
                optimizer = fleet.distributed_optimizer(optimizer, strategy)
2352 2353

        """
2354 2355 2356
        return self.strategy.cudnn_exhaustive_search

    @cudnn_exhaustive_search.setter
2357
    @is_strict_auto
2358 2359 2360 2361
    def cudnn_exhaustive_search(self, flag):
        if isinstance(flag, bool):
            self.strategy.cudnn_exhaustive_search = flag
        else:
2362 2363
            logger.warning(
                "cudnn_exhaustive_search should have value of bool type"
2364 2365 2366 2367
            )

    @property
    def conv_workspace_size_limit(self):
2368
        """
2369

2370 2371 2372 2373 2374 2375 2376
        The workspace limit size in MB unit for choosing cuDNN convolution algorithms.
        The inner funciton of cuDNN obtain the fastest suited algorithm that fits within this memory limit.
        Usually, large workspace size may lead to choose faster algorithms,
        but significant increasing memory workspace. Users need to trade-off between memory and speed.
        Default Value: 4000

        Examples:
2377
            .. code-block:: python
1
123malin 已提交
2378

2379 2380 2381
                import paddle
                paddle.enable_static()
                import paddle.distributed.fleet as fleet
2382

2383 2384
                strategy = fleet.DistributedStrategy()
                strategy.conv_workspace_size_limit = 1024
2385

2386 2387
                optimizer = paddle.optimizer.SGD(learning_rate=0.01)
                optimizer = fleet.distributed_optimizer(optimizer, strategy)
1
123malin 已提交
2388

2389
        """
2390 2391 2392
        return self.strategy.conv_workspace_size_limit

    @conv_workspace_size_limit.setter
2393
    @is_strict_auto
2394 2395 2396 2397
    def conv_workspace_size_limit(self, value):
        if isinstance(value, int):
            self.strategy.conv_workspace_size_limit = value
        else:
2398 2399
            logger.warning(
                "conv_workspace_size_limit should have value of int type"
2400 2401 2402 2403
            )

    @property
    def cudnn_batchnorm_spatial_persistent(self):
2404
        """
2405

2406 2407 2408 2409 2410
        Indicates whether to use the mode CUDNN_BATCHNORM_SPATIAL_PERSISTENT function in batchnorm.
        This is only useful in cudnn.
        Default Value: True

        Examples:
2411
            .. code-block:: python
1
123malin 已提交
2412

2413 2414 2415
                import paddle
                paddle.enable_static()
                import paddle.distributed.fleet as fleet
2416

2417 2418
                strategy = fleet.DistributedStrategy()
                strategy.cudnn_batchnorm_spatial_persistent = True
2419

2420 2421
                optimizer = paddle.optimizer.SGD(learning_rate=0.01)
                optimizer = fleet.distributed_optimizer(optimizer, strategy)
2422 2423

        """
2424 2425 2426
        return self.strategy.cudnn_batchnorm_spatial_persistent

    @cudnn_batchnorm_spatial_persistent.setter
2427
    @is_strict_auto
2428 2429 2430 2431
    def cudnn_batchnorm_spatial_persistent(self, flag):
        if isinstance(flag, bool):
            self.strategy.cudnn_batchnorm_spatial_persistent = flag
        else:
2432 2433
            logger.warning(
                "cudnn_batchnorm_spatial_persistent should have value of bool type"
2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455
            )

    def _enable_env(self):
        strategy = self.strategy
        keys = [
            "FLAGS_cudnn_batchnorm_spatial_persistent",
            "FLAGS_conv_workspace_size_limit",
            "FLAGS_cudnn_exhaustive_search",
            "FLAGS_sync_nccl_allreduce",
            "FLAGS_fuse_parameter_memory_size",
            "FLAGS_fuse_parameter_groups_size",
        ]
        values = [
            bool(strategy.cudnn_batchnorm_spatial_persistent),
            int(strategy.conv_workspace_size_limit),
            bool(strategy.cudnn_exhaustive_search),
            bool(strategy.sync_nccl_allreduce),
            int(strategy.fuse_grad_size_in_MB),
            int(strategy.fuse_grad_size_in_TFLOPS),
        ]

        for i, key in enumerate(keys):
2456 2457
            if _global_flags().is_public(key):
                _global_flags()[key] = values[i]
2458

2459 2460 2461 2462 2463 2464
    def _is_strict_auto(self):
        global non_auto_func_called
        if self.strategy.auto and non_auto_func_called:
            return True
        return False

2465
    def __repr__(self):
2466 2467 2468 2469 2470 2471 2472
        spacing = 2
        max_k = 38
        max_v = 38

        length = max_k + max_v + spacing

        h1_format = "    " + "|{{:^{}s}}|\n".format(length)
2473
        h2_format = "    " + "|{{:>{}s}}{}{{:^{}s}}|\n".format(
2474 2475
            max_k, " " * spacing, max_v
        )
2476 2477 2478 2479 2480 2481 2482 2483 2484

        border = "    +" + "".join(["="] * length) + "+"
        line = "    +" + "".join(["-"] * length) + "+"

        draws = border + "\n"
        draws += h1_format.format("")
        draws += h1_format.format("DistributedStrategy Overview")
        draws += h1_format.format("")

D
Dong Daxiang 已提交
2485
        fields = self.strategy.DESCRIPTOR.fields
2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499
        str_res = ""

        env_draws = line + "\n"
        for f in fields:
            if "build_strategy" in f.name or "execution_strategy" in f.name:
                continue
            if "_configs" in f.name:
                continue
            else:
                if isinstance(getattr(self.strategy, f.name), bool):
                    if hasattr(self.strategy, f.name + "_configs"):
                        if getattr(self.strategy, f.name):
                            draws += border + "\n"
                            draws += h1_format.format(
2500 2501
                                "{}=True <-> {}_configs".format(f.name, f.name)
                            )
2502
                            draws += line + "\n"
2503 2504 2505
                            my_configs = getattr(
                                self.strategy, f.name + "_configs"
                            )
2506 2507 2508
                            config_fields = my_configs.DESCRIPTOR.fields
                            for ff in config_fields:
                                if isinstance(
2509
                                    getattr(my_configs, ff.name),
R
risemeup1 已提交
2510
                                    _message.RepeatedScalarContainer,
2511
                                ):
2512 2513 2514
                                    values = getattr(my_configs, ff.name)
                                    for i, v in enumerate(values):
                                        if i == 0:
2515
                                            draws += h2_format.format(
2516 2517
                                                ff.name, str(v)
                                            )
2518
                                        else:
2519
                                            draws += h2_format.format(
2520 2521
                                                "", str(v)
                                            )
2522 2523 2524
                                else:
                                    draws += h2_format.format(
                                        ff.name,
2525 2526
                                        str(getattr(my_configs, ff.name)),
                                    )
2527 2528
                    else:
                        env_draws += h2_format.format(
2529 2530
                            f.name, str(getattr(self.strategy, f.name))
                        )
2531 2532
                else:
                    env_draws += h2_format.format(
2533 2534 2535 2536 2537 2538 2539 2540 2541
                        f.name, str(getattr(self.strategy, f.name))
                    )

        result_res = (
            draws
            + border
            + "\n"
            + h1_format.format("Environment Flags, Communication Flags")
        )
2542 2543 2544 2545 2546 2547 2548
        result_res += env_draws

        build_strategy_str = border + "\n"
        build_strategy_str += h1_format.format("Build Strategy")
        build_strategy_str += line + "\n"

        fields = self.strategy.build_strategy.DESCRIPTOR.fields
D
Dong Daxiang 已提交
2549
        for f in fields:
2550
            build_strategy_str += h2_format.format(
2551 2552
                f.name, str(getattr(self.strategy.build_strategy, f.name))
            )
2553 2554 2555 2556 2557 2558 2559 2560
        build_strategy_str += border + "\n"

        execution_strategy_str = h1_format.format("Execution Strategy")
        execution_strategy_str += line + "\n"

        fields = self.strategy.execution_strategy.DESCRIPTOR.fields
        for f in fields:
            execution_strategy_str += h2_format.format(
2561 2562
                f.name, str(getattr(self.strategy.execution_strategy, f.name))
            )
2563 2564 2565 2566
        execution_strategy_str += border + "\n"

        result_res += build_strategy_str + execution_strategy_str
        return result_res