distributed_strategy.py 58.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
#   Copyright (c) 2020 PaddlePaddle Authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

15
import paddle
16
from paddle.distributed.fleet.proto import distributed_strategy_pb2
17
from paddle.fluid.framework import Variable, set_flags, core
18
from paddle.fluid.wrapped_decorator import wrap_decorator
19
import google.protobuf.text_format
20
import google.protobuf
21

22
__all__ = []
23

24 25 26 27 28 29 30 31 32 33 34 35 36 37
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__)

38

39 40 41 42 43 44 45 46 47 48 49 50 51
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:
52 53 54
                # LABEL_OPTIONAL = 1
                # LABEL_REPEATED = 3
                # LABEL_REQUIRED = 2
55 56 57 58 59 60 61 62 63 64 65 66
                if f.label == 3:
                    getattr(msg, f.name).extend(config[f.name])
                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)


67 68 69 70 71 72 73 74 75 76 77 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
class DistributedJobInfo(object):
    """
    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


class DistributedStrategy(object):
105 106
    __lock_attr = False

107
    def __init__(self):
108 109 110 111 112
        """
        DistributedStrategy is the main configuration entry for distributed training of Paddle.
        All of the distributed training configurations can be configured in DistributedStrategy,
        such as automatic mixed precision (AMP), Layer-wise Adaptive Rate Scaling (LARS), 
        asynchronous update parameter server(ASGD), etc.
1
123malin 已提交
113

114 115 116 117 118 119
        DistributedStrategy can be serialized into protobuf file or deserialized from protobuf file

        Users who run local training usually configure BuildStrategy and ExecutionStrategy, and 
        DistributedStrategy supports configurations from BuildStrategy and ExecutionStrategy

        """
120
        self.strategy = distributed_strategy_pb2.DistributedStrategy()
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136

        # Set the default values of the following flags to the ones set by users
        key = 'FLAGS_cudnn_batchnorm_spatial_persistent'
        if core.globals().is_public(key):
            self.strategy.cudnn_batchnorm_spatial_persistent = bool(
                core.globals()[key])
        key = 'FLAGS_conv_workspace_size_limit'
        if core.globals().is_public(key):
            self.strategy.conv_workspace_size_limit = int(core.globals()[key])
        key = 'FLAGS_cudnn_exhaustive_search'
        if core.globals().is_public(key):
            self.strategy.cudnn_exhaustive_search = bool(core.globals()[key])
        key = 'FLAGS_sync_nccl_allreduce'
        if core.globals().is_public(key):
            self.strategy.sync_nccl_allreduce = bool(core.globals()[key])

137 138 139 140 141 142 143
        self.__lock_attr = True

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

145
    def save_to_prototxt(self, output):
146 147 148 149
        """
        Serialize current DistributedStrategy to string and save to output file

        Examples:
1
123malin 已提交
150

151
          .. code-block:: python
1
123malin 已提交
152

153
            import paddle.distributed.fleet as fleet
154 155 156
            strategy = fleet.DistributedStrategy()
            strategy.dgc = True
            strategy.recompute = True
M
mapingshuo 已提交
157
            strategy.recompute_configs = {"checkpoints": ["x"]}
158 159
            strategy.save_to_prototxt("dist_strategy.prototxt")
        """
160 161 162 163
        with open(output, "w") as fout:
            fout.write(str(self.strategy))

    def load_from_prototxt(self, pb_file):
164 165 166 167
        """
        Load from prototxt file for DistributedStrategy initialization

        Examples:
1
123malin 已提交
168

169 170
          .. code-block:: python

171
            import paddle.distributed.fleet as fleet
172
            strategy = fleet.DistributedStrategy()
M
mapingshuo 已提交
173
            strategy.load_from_prototxt("dist_strategy.prototxt")
174 175 176 177 178 179 180 181 182 183 184
        """
        with open(pb_file, 'r') as f:
            self.strategy = google.protobuf.text_format.Merge(
                str(f.read()), self.strategy)

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

        Examples:
1
123malin 已提交
185

186 187
          .. code-block:: python

M
mapingshuo 已提交
188
            import paddle
1
123malin 已提交
189
            exe_strategy = paddle.static.ExecutionStrategy()
190 191 192 193
            exe_strategy.num_threads = 10
            exe_strategy.num_iteration_per_drop_scope = 10
            exe_strategy.num_iteration_per_run = 10

194
            strategy = paddle.distributed.fleet.DistributedStrategy()
195 196 197 198 199 200 201 202 203 204
            strategy.execution_strategy = exe_strategy
        """
        execution_strategy = paddle.fluid.ExecutionStrategy()
        fields = self.strategy.execution_strategy.DESCRIPTOR.fields
        for f in fields:
            setattr(execution_strategy, f.name,
                    getattr(self.strategy.execution_strategy, f.name))
        return execution_strategy

    @execution_strategy.setter
205
    @is_strict_auto
206 207 208 209 210 211 212 213 214 215 216 217 218 219
    def execution_strategy(self, strategy):
        fields = self.strategy.execution_strategy.DESCRIPTOR.fields
        for f in fields:
            setattr(self.strategy.execution_strategy, f.name,
                    getattr(strategy, f.name))

    @property
    def build_strategy(self):
        """
        Configure BuildStrategy for DistributedStrategy
        Note that the properties of BuildStrategy are valid in DistributedStrategy
        only if the property is non-distributed strategy.

        Examples:
1
123malin 已提交
220

221 222
          .. code-block:: python

M
mapingshuo 已提交
223
            import paddle
1
123malin 已提交
224
            build_strategy = paddle.static.BuildStrategy()
225 226 227 228 229 230 231 232
            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
1
123malin 已提交
233

234
            strategy = paddle.distributed.fleet.DistributedStrategy()
235 236 237 238 239 240 241 242 243 244 245
            strategy.build_strategy = build_strategy
        """

        build_strategy = paddle.fluid.BuildStrategy()
        fields = self.strategy.build_strategy.DESCRIPTOR.fields
        for f in fields:
            setattr(build_strategy, f.name,
                    getattr(self.strategy.build_strategy, f.name))
        return build_strategy

    @build_strategy.setter
246
    @is_strict_auto
247 248 249 250 251 252 253 254 255 256 257
    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
                setattr(self.strategy.build_strategy, f.name,
                        getattr(strategy, f.name))
            elif f.label == 3:  # repeated field
                getattr(self.strategy.build_strategy,
                        f.name).extend(getattr(strategy, f.name))

    @property
D
Dong Daxiang 已提交
258
    def a_sync(self):
259 260 261 262 263 264 265
        """
        Indicating whether we are using asynchronous stocastic gradient descent updates
        for training. This property is valid when we are using parameter server training, 
        which is implied by setting approperate RoleMaker
        Default value: True

        Examples:
1
123malin 已提交
266

267 268
          .. code-block:: python

269
            import paddle.distributed.fleet as fleet
270 271 272 273
            role_maker = fleet.PaddleCloudRoleMaker()
            fleet.init(role_maker)

            strategy = fleet.DistributedStrategy()
D
Dong Daxiang 已提交
274
            strategy.a_sync = True  # by default this is True
1
123malin 已提交
275

276 277 278
            # code block for defining loss and local optimizer
            # sgd = fleet.distributed_optimizer(optimizer, strategy)
        """
D
Dong Daxiang 已提交
279
        return self.strategy.a_sync
280

D
Dong Daxiang 已提交
281
    @a_sync.setter
282
    @is_strict_auto
D
Dong Daxiang 已提交
283
    def a_sync(self, flag):
284
        if isinstance(flag, bool):
D
Dong Daxiang 已提交
285
            self.strategy.a_sync = flag
286
            self.a_sync_configs = {"k_steps": 0}
287
        else:
288 289 290
            raise ValueError(
                "The type of `flag` is invalid, expected type is bool, but received %s".
                format(type(flag)))
291 292

    @property
D
Dong Daxiang 已提交
293
    def a_sync_configs(self):
294
        """
D
Dong Daxiang 已提交
295
        Set a_sync update configurations. In general, asynchronous parameter server
296 297
        training has serveral configurable settings that can be configured through
        a dict.
298

299
        **Notes**:
M
mapingshuo 已提交
300 301 302 303 304 305 306 307 308 309 310 311 312
            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
313

314
        Examples:
1
123malin 已提交
315

316
          .. code-block:: python
317

318
            import paddle.distributed.fleet as fleet
319 320
            role_maker = fleet.PaddleCloudRoleMaker()
            fleet.init(role_maker)
321

322
            strategy = fleet.DistributedStrategy()
D
Dong Daxiang 已提交
323
            strategy.a_sync = True  # by default this is True
M
mapingshuo 已提交
324
            configs = {"k_steps": 1024, "send_queue_size": 32}
D
Dong Daxiang 已提交
325
            strategy.a_sync_configs = configs
326

327 328
            # code block for defining loss and local optimizer
            # sgd = fleet.distributed_optimizer(optimizer, strategy)
M
mapingshuo 已提交
329

330
        """
D
Dong Daxiang 已提交
331
        return get_msg_dict(self.strategy.a_sync_configs)
332

D
Dong Daxiang 已提交
333
    @a_sync_configs.setter
334
    @is_strict_auto
D
Dong Daxiang 已提交
335 336 337 338
    def a_sync_configs(self, configs):
        check_configs_key(self.strategy.a_sync_configs, configs,
                          "a_sync_configs")
        assign_configs_value(self.strategy.a_sync_configs, configs)
339

340
    @property
341 342 343 344
    def amp(self):
        """
        Indicating whether we are using automatic mixed precision training
        Default Value: False
345

346
        Examples:
1
123malin 已提交
347

348
          .. code-block:: python
349

350
            import paddle.distributed.fleet as fleet
351 352
            strategy = fleet.DistributedStrategy()
            strategy.amp = True # by default this is false
353

354 355
        """
        return self.strategy.amp
356

357
    @amp.setter
358
    @is_strict_auto
359
    def amp(self, flag):
360
        if isinstance(flag, bool):
361
            self.strategy.amp = flag
362
        else:
363
            print("WARNING: amp should have value of bool type")
364 365

    @property
366
    def amp_configs(self):
367 368 369 370 371
        """
        Set automatic mixed precision training configurations. In general, amp has serveral configurable
        settings that can be configured through a dict.

        **Notes**:
M
mapingshuo 已提交
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386
            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.
387

388 389 390 391 392 393 394 395
            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:
1
123malin 已提交
396

397 398 399 400 401 402 403 404
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.amp = True
            strategy.amp_configs = {
                "init_loss_scaling": 32768,
                "custom_white_list": ['conv2d']}
405 406 407 408 409 410 411 412 413 414 415 416 417

        Examples 2:

          .. 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
            }
418
        """
419
        return get_msg_dict(self.strategy.amp_configs)
420

421
    @amp_configs.setter
422
    @is_strict_auto
423 424 425
    def amp_configs(self, configs):
        check_configs_key(self.strategy.amp_configs, configs, "amp_configs")
        assign_configs_value(self.strategy.amp_configs, configs)
426 427

    @property
428 429 430 431 432 433
    def recompute(self):
        """
        Indicating whether we are using forward recomputation for memory optimization
        Default value: False

        Examples:
1
123malin 已提交
434

435 436
          .. code-block:: python

437
            import paddle.distributed.fleet as fleet
438 439 440 441 442 443
            strategy = fleet.DistributedStrategy()
            strategy.recompute = True
            # suppose x and y are names of checkpoint tensors for recomputation
            strategy.recompute_configs = {"checkpoints": ["x", "y"]}
        """
        return self.strategy.recompute
444

445 446
    @property
    def sync_nccl_allreduce(self):
447 448 449 450 451
        """
        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:
1
123malin 已提交
452

453 454 455 456 457 458
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.sync_nccl_allreduce = True
        """
459 460 461
        return self.strategy.sync_nccl_allreduce

    @sync_nccl_allreduce.setter
462
    @is_strict_auto
463 464 465 466
    def sync_nccl_allreduce(self, flag):
        if isinstance(flag, bool):
            self.strategy.sync_nccl_allreduce = flag
        else:
467
            print("WARNING: sync_nccl_allreduce should have value of bool type")
468

469
    @property
470
    def use_hierarchical_allreduce(self):
471 472 473 474 475 476
        """
        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:
1
123malin 已提交
477

478 479 480 481 482 483
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.use_hierarchical_allreduce = True
        """
484
        return self.strategy.use_hierarchical_allreduce
485

486
    @use_hierarchical_allreduce.setter
487
    @is_strict_auto
488
    def use_hierarchical_allreduce(self, flag):
489
        if isinstance(flag, bool):
490
            self.strategy.use_hierarchical_allreduce = flag
491 492
        else:
            print(
493
                "WARNING: use_hierarchical_allreduce should have value of bool type"
494 495 496
            )

    @property
497
    def hierarchical_allreduce_inter_nranks(self):
498 499 500 501 502
        """
        Number of ranks for low level node groups in hierarchical allreduce
        Default value: number of GPU cards on each single GPU machine

        Example:
1
123malin 已提交
503

504 505 506 507 508 509
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.hierarchical_allreduce_inter_nranks = 8
        """
510
        return self.strategy.hierarchical_allreduce_inter_nranks
511

512
    @hierarchical_allreduce_inter_nranks.setter
513
    @is_strict_auto
514 515 516
    def hierarchical_allreduce_inter_nranks(self, value):
        if isinstance(value, int):
            self.strategy.hierarchical_allreduce_inter_nranks = value
517 518
        else:
            print(
519
                "WARNING: hierarchical_allreduce_inter_nranks should have value of int type"
520 521
            )

522
    @property
523
    def sync_batch_norm(self):
524 525
        """
        Indicating whether we are using sync_batch_norm to do synchronous batch normalization among all training nodes.
1
123malin 已提交
526

527 528 529
        Default value: False

        Examples:
1
123malin 已提交
530

531 532 533 534 535 536 537
          .. code-block:: python

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

538
        return self.strategy.sync_batch_norm
539

540
    @sync_batch_norm.setter
541
    @is_strict_auto
542
    def sync_batch_norm(self, flag):
543
        if isinstance(flag, bool):
544
            self.strategy.sync_batch_norm = flag
545
        else:
546
            print("WARNING: sync_batch_norm should have value of bool type")
547 548 549

    @property
    def fuse_all_reduce_ops(self):
550 551 552 553 554
        """
        Indicating whether we are using fuse_all_reduce_ops for gradient fusion during backward phase of training
        Default value: True

        Examples:
1
123malin 已提交
555

556 557 558 559 560 561
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.fuse_all_reduce_ops = False
        """
562 563 564
        return self.strategy.fuse_all_reduce_ops

    @fuse_all_reduce_ops.setter
565
    @is_strict_auto
566 567 568 569 570 571
    def fuse_all_reduce_ops(self, flag):
        if isinstance(flag, bool):
            self.strategy.fuse_all_reduce_ops = flag
        else:
            print("WARNING: fuse_all_reduce_ops should have value of bool type")

572 573
    @property
    def fuse_grad_size_in_MB(self):
574 575 576 577 578 579
        """
        Specifying the size of gradient to fuse in Mega-Bytes

        Default value: 32

        Examples:
1
123malin 已提交
580

581
          .. code-block:: python
1
123malin 已提交
582

583 584 585 586
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.fuse_grad_size_in_MB = 50
        """
587 588 589
        return self.strategy.fuse_grad_size_in_MB

    @fuse_grad_size_in_MB.setter
590
    @is_strict_auto
591 592 593 594 595 596
    def fuse_grad_size_in_MB(self, value):
        if isinstance(value, int):
            self.strategy.fuse_grad_size_in_MB = value
        else:
            print("WARNING: fuse_grad_size_in_MB should have value of int type")

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
    @property
    def last_comm_group_size_MB(self):
        """
        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. 

        Default value: 1

        Examples:
          .. code-block:: python
        
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.last_comm_group_size_MB = 2
        """
        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")

623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
    @property
    def find_unused_parameters(self):
        """
        Indicating whether we are using find_unused_parameters to 
        find unused parameters in DataParallel.

        Default value: True

        Examples:

          .. code-block:: python

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

        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:
            print(
                "WARNING: find_unused_parameters should have value of bool type")

651 652 653 654 655
    @property
    def _fuse_grad_size_in_TFLOPS(self):
        return self.strategy.fuse_grad_size_in_TFLOPS

    @_fuse_grad_size_in_TFLOPS.setter
656
    @is_strict_auto
657 658 659 660 661 662 663 664
    def _fuse_grad_size_in_TFLOPS(self, value):
        if isinstance(value, float):
            self.strategy.fuse_grad_size_in_TFLOPS = value
        else:
            print(
                "WARNING: fuse_grad_size_in_TFLOPS should have value of float type"
            )

665
    @property
666
    def nccl_comm_num(self):
667 668 669 670 671 672
        """
        Specifying the number of NCCL communicator

        Default value: 1

        Examples:
1
123malin 已提交
673

674
          .. code-block:: python
1
123malin 已提交
675

676 677 678 679 680
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.nccl_comm_num = 2
        """

681
        return self.strategy.nccl_comm_num
682

683
    @nccl_comm_num.setter
684
    @is_strict_auto
685
    def nccl_comm_num(self, value):
686
        if isinstance(value, int):
687
            self.strategy.nccl_comm_num = value
688
        else:
689
            print("WARNING: nccl_comm_num should have value of int type")
690

691
    @recompute.setter
692
    @is_strict_auto
693
    def recompute(self, flag):
694
        if isinstance(flag, bool):
695
            self.strategy.recompute = flag
696
        else:
697
            print("WARNING: recompute should have value of bool type")
698 699

    @property
700 701
    def recompute_configs(self):
        """
J
JZ-LIANG 已提交
702 703 704 705 706 707 708 709 710 711 712 713 714 715
        Set recompute configurations. 
        
        **Note**:
        checkpoints(list): list of string name of checkpoints. In general, the recompute
        strategy of current implementation should have some manually assign checkpoints.

        enable_offload(bool): enable recompute checkpoints offload feature. this feature 
        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
        specific here should be determined ("-1" is not allowed). 
716

717
        Examples:
1
123malin 已提交
718

719
          .. code-block:: python
1
123malin 已提交
720

721
            import paddle.distributed.fleet as fleet
722 723
            strategy = fleet.DistributedStrategy()
            strategy.recompute = True
J
JZ-LIANG 已提交
724 725 726 727
            strategy.recompute_configs = {
                "checkpoints": ["x", "y"],
                "enable_offload": True,
                "checkpoint_shape": [100, 512, 1024] }
728 729 730 731 732

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

    @recompute_configs.setter
733
    @is_strict_auto
734 735 736 737
    def recompute_configs(self, configs):
        check_configs_key(self.strategy.recompute_configs, configs,
                          "checkpoint_configs")
        assign_configs_value(self.strategy.recompute_configs, configs)
738

739 740 741 742
    @property
    def sharding(self):
        """
        Indicating whether we are using sharding Optimizer for memory
J
JZ-LIANG 已提交
743 744 745
        optimization. We implement the sharding optimizer following the ZeRO-DP 
        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.
746

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

749 750 751
        Default value: False

        Examples:
1
123malin 已提交
752

753
          .. code-block:: python
1
123malin 已提交
754

755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
            import paddle.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.sharding = True
        """
        return self.strategy.sharding

    @sharding.setter
    @is_strict_auto
    def sharding(self, flag):
        if isinstance(flag, bool):
            self.strategy.sharding = flag
        else:
            print("WARNING: sharding should have value of bool type")

    @property
    def sharding_configs(self):
        """
J
JZ-LIANG 已提交
772
        Set sharding configurations. 
773 774

        **Note**:
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
            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 
            communication. Default is segment_broadcast_MB.

            segment_broadcast_MB(float, optional): segment by the parameters broadcast volume. sharding will introduce parameter broadcast operations into program, and 
            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 .

            segment_anchors(list): list of anchors used to segment the program, which allows a finner control of program segmentation. 
            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.

            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. 
            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.

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

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

801 802
            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. 
            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 已提交
803 804


805
        Examples:
1
123malin 已提交
806

807
          .. code-block:: python
1
123malin 已提交
808

809
            # sharding-DP, 2 nodes with 8 gpus per node
810 811 812
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.sharding = True
J
JZ-LIANG 已提交
813
            strategy.sharding_configs = {
814 815 816 817 818 819
                "sharding_segment_strategy": "segment_broadcast_MB",
                "segment_broadcast_MB": 32,
                "sharding_degree": 8,
                "sharding_degree": 2,
                "gradient_merge_acc_step": 4,
                }
820 821 822 823 824 825 826 827 828 829
        """
        return get_msg_dict(self.strategy.sharding_configs)

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

830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855
    @property
    def without_graph_optimization(self):
        """
        Run program using Executor other than ParallelExecutor.

        Examples:

          .. code-block:: python

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

        """
        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:
            print(
                "WARNING: without_graph_optimization should have value of bool type"
            )

856
    @property
857 858 859 860 861 862 863 864
    def pipeline(self):
        """
        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:
1
123malin 已提交
865

866
          .. code-block:: python
1
123malin 已提交
867

868
            import paddle.distributed.fleet as fleet
869 870 871 872 873
            strategy = fleet.DistributedStrategy()
            strategy.pipeline = True

        """
        return self.strategy.pipeline
874

875
    @pipeline.setter
876
    @is_strict_auto
877
    def pipeline(self, flag):
878
        if isinstance(flag, bool):
879
            self.strategy.pipeline = flag
880
        else:
881
            print("WARNING: pipeline should have value of bool type")
882 883

    @property
884 885 886 887 888 889 890 891 892 893
    def pipeline_configs(self):
        """
        Set pipeline parallelism configurations. In pipeline parallelism,
        different parts of neural networks are running on different GPUS.
        There are Tensor queue buffer between each pair of neighborhood GPUS 
        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
        pipeline parallelism is to make the size of Tensor in Tensor queue smaller, 
        so that we will have a faster producer for downstream consumers.
894

895 896
        **Notes**:
            **Detailed arguments for pipeline_configs**
M
mapingshuo 已提交
897

898
            **micro_batch_size**: the number of small batches in each user defined batch
899

900
        Examples:
1
123malin 已提交
901

902
          .. code-block:: python
1
123malin 已提交
903

904
            import paddle.distributed.fleet as fleet
905 906
            strategy = fleet.DistributedStrategy()
            strategy.pipeline = True
907
            strategy.pipeline_configs = {"micro_batch_size": 12}
908

909
        """
910

911
        return get_msg_dict(self.strategy.pipeline_configs)
912

913
    @pipeline_configs.setter
914
    @is_strict_auto
915 916 917 918
    def pipeline_configs(self, configs):
        check_configs_key(self.strategy.pipeline_configs, configs,
                          "pipeline_configs")
        assign_configs_value(self.strategy.pipeline_configs, configs)
919

L
lilong12 已提交
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
    @property
    def tensor_parallel(self):
        """
        Indicating whether we are using tensor parallel for distributed training.

        Examples:

          .. code-block:: python

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

        """
        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:
            print("WARNING: tensor_parallel should have value of bool type")

    @property
    def tensor_parallel_configs(self):
        """
        Set tensor_parallel configurations.

        **Notes**:
            **Detailed arguments for tensor_parallel_configs**
            **tensor_parallel_degree**: degree of tensor parallel

        Examples:

          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.tensor_parallel = True
            strategy.tensor_parallel_configs = {"tensor_parallel_degree": 4}

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

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

972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005
    @property
    def hybrid_configs(self):
        """
        Dynamic graph hybrid parallel strategy configuration. Three-way hybrid parallelism 
        needs to meet the following relationships

        total_number_GPUs = dp_degree * mp_degree * pp_degree

        **Note**:
            dp_degree(int): set number of GPUs in a data parallel group. Default -1.
                                    This value should be an integer greater than 0.
                                    If it is not set, or set to -1, its value will be inferred 
                                    based on the total number of cards.
            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


        Examples:
          .. code-block:: python
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.hybrid_configs = {
                "dp_degree": 1,
                "mp_degree": 2,
                "pp_degree": 1}
        """
        return get_msg_dict(self.strategy.hybrid_configs)

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

1006
    @property
1007
    def localsgd(self):
1008
        """
M
mapingshuo 已提交
1009 1010 1011
        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>`_.
1012 1013 1014


        Examples:
1
123malin 已提交
1015

1016 1017 1018 1019 1020 1021 1022
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.localsgd = True # by default this is false

        """
1023
        return self.strategy.localsgd
1024

1025
    @localsgd.setter
1026
    @is_strict_auto
1027 1028 1029
    def localsgd(self, flag):
        if isinstance(flag, bool):
            self.strategy.localsgd = flag
1030
        else:
1031
            print("WARNING: localsgd should have value of bool type")
1032 1033

    @property
1034
    def localsgd_configs(self):
1035 1036 1037 1038 1039
        """
        Set LocalSGD training configurations. LocalSGD has a configurable
        setting that can be configured through a dict.

        **Notes**:
M
mapingshuo 已提交
1040
            k_steps(int) The local steps for training before parameter synchronization. Default 1.
1041
            begin_step(int) The step of begining training by localsgd. Default 1.
1042 1043

        Examples:
1
123malin 已提交
1044

1045 1046 1047 1048 1049
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.localsgd = True
1050 1051
            strategy.localsgd_configs = {"k_steps": 4,
                                         "begin_step": 30}
1052 1053
        """

1054
        return get_msg_dict(self.strategy.localsgd_configs)
1055

1056
    @localsgd_configs.setter
1057
    @is_strict_auto
1058 1059 1060 1061
    def localsgd_configs(self, configs):
        check_configs_key(self.strategy.localsgd_configs, configs,
                          "localsgd_configs")
        assign_configs_value(self.strategy.localsgd_configs, configs)
1062

1063 1064 1065 1066 1067 1068 1069 1070 1071
    @property
    def adaptive_localsgd(self):
        """
        Indicating whether we are using Adaptive Local SGD training. Default Value: False
        For more details, please refer to `Adaptive Communication Strategies to Achieve 
        the Best Error-Runtime Trade-off in Local-Update SGD <https://arxiv.org/pdf/1810.08313.pdf>`_.


        Examples:
1
123malin 已提交
1072

1073 1074 1075 1076 1077 1078 1079
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.adaptive_localsgd = True # by default this is false

        """
1080
        return self.strategy.adaptive_localsgd
1081 1082 1083 1084 1085

    @adaptive_localsgd.setter
    @is_strict_auto
    def adaptive_localsgd(self, flag):
        if isinstance(flag, bool):
1086
            self.strategy.adaptive_localsgd = flag
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
        else:
            print("WARNING: adaptive_localsgd should have value of bool type")

    @property
    def adaptive_localsgd_configs(self):
        """
        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.
            begin_step(int) The step of begining training by adaptive localsgd. Default 1.

        Examples:
1
123malin 已提交
1103

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.adaptive_localsgd = True
            strategy.adaptive_localsgd_configs = {"init_k_steps": 1,
                                                  "begin_step": 30}
        """

        return get_msg_dict(self.strategy.adaptive_localsgd_configs)

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

1122
    @property
1123
    def dgc(self):
1124 1125 1126 1127 1128 1129 1130
        """
        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:
1
123malin 已提交
1131

1132 1133 1134 1135 1136 1137 1138
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.dgc = True # by default this is false

        """
1139
        return self.strategy.dgc
1140

1141
    @dgc.setter
1142
    @is_strict_auto
1143 1144 1145
    def dgc(self, flag):
        if isinstance(flag, bool):
            self.strategy.dgc = flag
1146
        else:
1147
            print("WARNING: dgc should have value of bool type")
1148 1149

    @property
1150
    def dgc_configs(self):
1151
        r"""
1152 1153 1154 1155
        Set Deep Gradient Compression training configurations. In general, dgc has serveral configurable
        settings that can be configured through a dict.

        **Notes**:
M
mapingshuo 已提交
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
            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.
1166 1167

        Examples:
1
123malin 已提交
1168

1169 1170 1171 1172 1173 1174 1175
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.dgc = True
            strategy.dgc_configs = {"rampup_begin_step": 1252}
        """
1176
        return get_msg_dict(self.strategy.dgc_configs)
1177

1178
    @dgc_configs.setter
1179
    @is_strict_auto
1180 1181 1182
    def dgc_configs(self, configs):
        check_configs_key(self.strategy.dgc_configs, configs, "dgc_configs")
        assign_configs_value(self.strategy.dgc_configs, configs)
1183

1184 1185 1186 1187 1188 1189 1190
    @property
    def fp16_allreduce(self):
        """
        Indicating whether we are using fp16 gradient allreduce training
        Default Value: False

        Examples:
1
123malin 已提交
1191

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.fp16_allreduce = True # by default this is false

        """
        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

1208
    @property
1209
    def gradient_merge(self):
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
        """
        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:
1
123malin 已提交
1221

M
mapingshuo 已提交
1222 1223
          .. code-block:: python

1224
            import paddle.distributed.fleet as fleet
1225 1226 1227 1228
            strategy = fleet.DistributedStrategy()
            strategy.gradient_merge = True
            strategy.gradient_merge_configs = {"k_steps": 4, "avg": True}
        """
1229
        return self.strategy.gradient_merge
1230

1231
    @gradient_merge.setter
1232
    @is_strict_auto
1233
    def gradient_merge(self, flag):
1234
        if isinstance(flag, bool):
1235
            self.strategy.gradient_merge = flag
1236
        else:
1237 1238 1239 1240
            print("WARNING: gradient_merge should have value of bool type")

    @property
    def gradient_merge_configs(self):
1241 1242
        """
        the key-value configs of distribute_strategy
M
mapingshuo 已提交
1243 1244 1245 1246 1247 1248 1249

        **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:
1
123malin 已提交
1250

M
mapingshuo 已提交
1251 1252
          .. code-block:: python

1253
            import paddle.distributed.fleet as fleet
1254 1255 1256 1257
            strategy = fleet.DistributedStrategy()
            strategy.gradient_merge = True
            strategy.gradient_merge_configs = {"k_steps": 4, "avg": True}
        """
1258 1259 1260
        return get_msg_dict(self.strategy.gradient_merge_configs)

    @gradient_merge_configs.setter
1261
    @is_strict_auto
1262 1263 1264 1265
    def gradient_merge_configs(self, configs):
        check_configs_key(self.strategy.gradient_merge_configs, configs,
                          "gradient_configs")
        assign_configs_value(self.strategy.gradient_merge_configs, configs)
1266 1267

    @property
1268
    def lars(self):
1269 1270 1271 1272 1273 1274 1275 1276
        """
        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 
        [Large Batch Training of Convolutional Networks](https://arxiv.org/abs/1708.03888).

        Default Value: False

        Examples:
1
123malin 已提交
1277

1278 1279 1280 1281 1282 1283
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.lars = True # by default this is false
        """
1284
        return self.strategy.lars
1285

1286
    @lars.setter
1287
    @is_strict_auto
1288
    def lars(self, flag):
1289
        if isinstance(flag, bool):
1290
            self.strategy.lars = flag
1291
        else:
1292
            print("WARNING: lars should have value of bool type")
1293

1294 1295
    @property
    def lars_configs(self):
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
        """
        Set Lars training configurations.

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

        Examples:
1
123malin 已提交
1308

1309
          .. code-block:: python
M
mapingshuo 已提交
1310

1311 1312 1313 1314 1315 1316 1317 1318 1319 1320
            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']
                    }
        """
1321 1322 1323
        return get_msg_dict(self.strategy.lars_configs)

    @lars_configs.setter
1324
    @is_strict_auto
1325 1326 1327 1328
    def lars_configs(self, configs):
        check_configs_key(self.strategy.lars_configs, configs, "lars_configs")
        assign_configs_value(self.strategy.lars_configs, configs)

1329
    @property
1330
    def lamb(self):
1331 1332 1333 1334 1335 1336 1337
        """
        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 
        [Large Batch Optimization for Deep Learning: Training BERT in 76 minutes](https://arxiv.org/abs/1904.00962).

        Default Value: False
1
123malin 已提交
1338

1339
        Examples:
1
123malin 已提交
1340

1341 1342 1343 1344 1345 1346 1347
          .. code-block:: python

            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.lamb = True # by default this is false
        """

1348
        return self.strategy.lamb
1349

1350
    @lamb.setter
1351
    @is_strict_auto
1352
    def lamb(self, flag):
1353
        if isinstance(flag, bool):
1354
            self.strategy.lamb = flag
1355
        else:
1356
            print("WARNING: lamb should have value of bool type")
1357

1358 1359
    @property
    def lamb_configs(self):
1360 1361 1362 1363 1364 1365 1366 1367 1368
        """
        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:
1
123malin 已提交
1369

1370
          .. code-block:: python
M
mapingshuo 已提交
1371

1372 1373 1374 1375 1376 1377 1378 1379
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.lamb = True
            strategy.lamb_configs = {
                    'lamb_weight_decay': 0.01,
                    'exclude_from_weight_decay': [],
                }
        """
1380 1381 1382
        return get_msg_dict(self.strategy.lamb_configs)

    @lamb_configs.setter
1383
    @is_strict_auto
1384 1385 1386 1387
    def lamb_configs(self, configs):
        check_configs_key(self.strategy.lamb_configs, configs, "lamb_configs")
        assign_configs_value(self.strategy.lamb_configs, configs)

1388 1389
    @property
    def elastic(self):
1390 1391 1392 1393
        """
        Indicating whether we want to do current distributed training on clusters with elastic resources.
        Currently, this is configuration is not valid.
        """
1394 1395 1396
        return self.strategy.elastic

    @elastic.setter
1397
    @is_strict_auto
1398 1399 1400 1401 1402 1403 1404 1405
    def elastic(self, flag):
        if isinstance(flag, bool):
            self.strategy.elastic = flag
        else:
            print("WARNING: elastic should have value of bool type")

    @property
    def auto(self):
1406 1407 1408 1409 1410 1411 1412 1413 1414
        """
        Indicating whether we are using auto-parallel configuration
        This feature is currently an experimental feature. Currently, 
        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:
1
123malin 已提交
1415

1416 1417 1418
          .. code-block:: python

            import paddle
1419
            paddle.enable_static()
1
123malin 已提交
1420
            import paddle.distributed.fleet as fleet
1421

1422 1423
            strategy = fleet.DistributedStrategy()
            strategy.auto = True
1424 1425
            # if set other strategy at the same time, auto will not apply
            # strategy.amp = True
1426 1427 1428 1429

            optimizer = paddle.optimizer.SGD(learning_rate=0.01)
            optimizer = fleet.distributed_optimizer(optimizer, strategy)
        """
1430 1431 1432 1433 1434 1435 1436 1437 1438
        return self.strategy.auto

    @auto.setter
    def auto(self, flag):
        if isinstance(flag, bool):
            self.strategy.auto = flag
        else:
            print("WARNING: auto should have value of bool type")

1439 1440
    @property
    def cudnn_exhaustive_search(self):
1441 1442 1443 1444 1445 1446 1447 1448
        """
        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:
1
123malin 已提交
1449

1450 1451
          .. code-block:: python

1
123malin 已提交
1452 1453
            import paddle
            paddle.enable_static()
1454 1455 1456 1457 1458 1459 1460
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.cudnn_exhaustive_search = False

            optimizer = paddle.optimizer.SGD(learning_rate=0.01)
            optimizer = fleet.distributed_optimizer(optimizer, strategy)
        """
1461 1462 1463
        return self.strategy.cudnn_exhaustive_search

    @cudnn_exhaustive_search.setter
1464
    @is_strict_auto
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474
    def cudnn_exhaustive_search(self, flag):
        if isinstance(flag, bool):
            self.strategy.cudnn_exhaustive_search = flag
        else:
            print(
                "WARNING: cudnn_exhaustive_search should have value of bool type"
            )

    @property
    def conv_workspace_size_limit(self):
1475 1476 1477 1478 1479 1480 1481 1482
        """
        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:
1
123malin 已提交
1483

1484 1485
          .. code-block:: python

1
123malin 已提交
1486 1487
            import paddle
            paddle.enable_static()
1488 1489 1490 1491 1492 1493
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.conv_workspace_size_limit = 1024

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

1495
        """
1496 1497 1498
        return self.strategy.conv_workspace_size_limit

    @conv_workspace_size_limit.setter
1499
    @is_strict_auto
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509
    def conv_workspace_size_limit(self, value):
        if isinstance(value, int):
            self.strategy.conv_workspace_size_limit = value
        else:
            print(
                "WARNING: conv_workspace_size_limit should have value of int type"
            )

    @property
    def cudnn_batchnorm_spatial_persistent(self):
1510 1511 1512 1513 1514 1515
        """
        Indicates whether to use the mode CUDNN_BATCHNORM_SPATIAL_PERSISTENT function in batchnorm.
        This is only useful in cudnn.
        Default Value: True

        Examples:
1
123malin 已提交
1516

1517 1518
          .. code-block:: python

1
123malin 已提交
1519 1520
            import paddle
            paddle.enable_static()
1521 1522 1523 1524 1525 1526 1527 1528
            import paddle.distributed.fleet as fleet
            strategy = fleet.DistributedStrategy()
            strategy.cudnn_batchnorm_spatial_persistent = True

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

        """
1529 1530 1531
        return self.strategy.cudnn_batchnorm_spatial_persistent

    @cudnn_batchnorm_spatial_persistent.setter
1532
    @is_strict_auto
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563
    def cudnn_batchnorm_spatial_persistent(self, flag):
        if isinstance(flag, bool):
            self.strategy.cudnn_batchnorm_spatial_persistent = flag
        else:
            print(
                "WARNING: cudnn_batchnorm_spatial_persistent should have value of bool type"
            )

    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):
            if core.globals().is_public(key):
                core.globals()[key] = values[i]

1564 1565 1566 1567 1568 1569
    def _is_strict_auto(self):
        global non_auto_func_called
        if self.strategy.auto and non_auto_func_called:
            return True
        return False

1570
    def __repr__(self):
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
        spacing = 2
        max_k = 38
        max_v = 38

        length = max_k + max_v + spacing

        h1_format = "    " + "|{{:^{}s}}|\n".format(length)
        h2_format = "    " + "|{{:>{}s}}{}{{:^{}s}}|\n".format(max_k, " " *
                                                               spacing, max_v)

        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 已提交
1589
        fields = self.strategy.DESCRIPTOR.fields
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
        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(
D
Dong Daxiang 已提交
1604
                                "{}=True <-> {}_configs".format(f.name, f.name))
1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641
                            draws += line + "\n"
                            my_configs = getattr(self.strategy,
                                                 f.name + "_configs")
                            config_fields = my_configs.DESCRIPTOR.fields
                            for ff in config_fields:
                                if isinstance(
                                        getattr(my_configs, ff.name),
                                        google.protobuf.pyext._message.
                                        RepeatedScalarContainer):
                                    values = getattr(my_configs, ff.name)
                                    for i, v in enumerate(values):
                                        if i == 0:
                                            draws += h2_format.format(ff.name,
                                                                      str(v))
                                        else:
                                            draws += h2_format.format("",
                                                                      str(v))
                                else:
                                    draws += h2_format.format(
                                        ff.name,
                                        str(getattr(my_configs, ff.name)))
                    else:
                        env_draws += h2_format.format(
                            f.name, str(getattr(self.strategy, f.name)))
                else:
                    env_draws += h2_format.format(
                        f.name, str(getattr(self.strategy, f.name)))

        result_res = draws + border + "\n" + h1_format.format(
            "Environment Flags, Communication Flags")
        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 已提交
1642
        for f in fields:
1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657
            build_strategy_str += h2_format.format(
                f.name, str(getattr(self.strategy.build_strategy, f.name)))
        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(
                f.name, str(getattr(self.strategy.execution_strategy, f.name)))
        execution_strategy_str += border + "\n"

        result_res += build_strategy_str + execution_strategy_str
        return result_res