paddlepaddle--paddle/python/paddle/distributed/auto_parallel/interface.py

#   Copyright (c) 2021 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.
from __future__ import annotations

from functools import reduce

import numpy as np

import paddle
from paddle.framework import core

from .process_mesh import ProcessMesh, get_current_process_mesh
from .static.dist_context import get_default_distributed_context
from .static.dist_op import DistributedOperatorHelper
from .static.dist_tensor import DistributedTensor
from .static.utils import (
    __no_shape_var_type__,
    convert_to_dims_mapping,
    verify_shard_spec,
)


def shard_tensor(x, process_mesh=None, shard_spec=None):
    """
    Shard a tensor on a process mesh according to the shard specification.

    Args:
        x (Tensor): the tensor to be sharded.
        process_mesh (ProcessMesh, optional): An instance of ProcessMesh describes a mesh
            topology of the used logical processes where the tensor is sharded. If it is None,
            the found current process mesh will be used. And an error will be raised if the
            current process mesh cannot be found. Default: None.
        shard_spec (list, optional): a list to describe the sharding mapping between `x` and `process_mesh`,
            which means the dimension `i` of `x` is split across the dimension `shard_spec[i]` of `process_mesh`,
            where `None` means that tensor dimension is not split. For example, given a tensor with
            the shape [6, 12] and a process mesh with the shape [2, 3] and the dimension names ["x", "y"]:
                If `shard_spec=["x", "y"]`, each shard of the tensor will have a shape [3, 4];
                If `shard_spec=["y", "x"]`, each shard of the tensor will have a shape [2, 6];
                If `shard_spec=["x", None]`, each shard of the tensor will have a shape [3, 12];
                If `shard_spec=[None, "x"]`, each shard of the tensor will have a shape [6, 4];
                If `shard_spec=["y", None]`, each shard of the tensor will have a shape [2, 12];
                If `shard_spec=[None, "y"]`, each shard of the tensor will have a shape [6, 4];
                If `shard_spec=[None, None]`, each shard of the tensor will have a shape [6, 12];
        If the `shard_spec` is None, the tensor will be replicated across all the processes of `process_mesh`.
        In the above example, the `shard_spec=None` is same as 'shard_spec=[None, None]'. Defaults: None.

    Returns:
        Tensor: the tensor `x` annotated with sharding information.

    Examples:
        .. code-block:: pycon

            >>> # doctest: +REQUIRES(env:DISTRIBUTED)
            >>> import paddle
            >>> from paddle.distributed.fleet import auto

            >>> mesh = auto.ProcessMesh([[0, 1], [2, 3]], dim_names=["x", "y"])
            >>> x = paddle.ones([4, 6])
            >>> shard_spec = ["x", "y"]
            >>> auto.shard_tensor(x, mesh, shard_spec)

    """

    if process_mesh is not None:
        assert isinstance(process_mesh, core.ProcessMesh), (
            f"Argument process_mesh {process_mesh} is not an instance of ProcessMesh"
        )
    else:
        process_mesh = get_current_process_mesh()
        assert process_mesh is not None, (
            "Specify the process mesh argument or use ProcessMesh context manager first."
        )
    assert isinstance(shard_spec, list), (
        f"Argument shard_spec {shard_spec} is not an instance of list"
    )
    if isinstance(x, str):
        x = (
            paddle.static.default_main_program()
            .global_block()
            ._var_recursive(x)
        )
        dist_tensor = DistributedTensor(x)
    else:
        dist_tensor = DistributedTensor(x)
    serial_tensor = dist_tensor.serial_tensor
    dist_tensor.dist_attr.process_mesh = process_mesh
    if serial_tensor.type in __no_shape_var_type__:
        tensor_shape = []
    else:
        tensor_shape = serial_tensor.shape
    if shard_spec is not None:
        valid_dims = (
            process_mesh.get_dim_names()
            if hasattr(process_mesh, "get_dim_names")
            else process_mesh.dim_names
        )
        for i, dim in enumerate(shard_spec):
            if dim is not None and (
                not isinstance(dim, str) or dim not in valid_dims
            ):
                raise ValueError(
                    f"Invalid shard_spec at index {i}: '{dim}' "
                    f"is not a valid dimension name in process_mesh {valid_dims}."
                )
        assert verify_shard_spec(shard_spec, tensor_shape, process_mesh), (
            f"For tensor {serial_tensor.name}, shard_spec {shard_spec} is invalid with tensor_shape {tensor_shape} and process_mesh {process_mesh}."
        )
        dist_tensor.dist_attr.dims_mapping = convert_to_dims_mapping(
            shard_spec, process_mesh
        )
    if process_mesh is not None:
        dist_tensor.dist_attr.mark_annotated("process_mesh")
    if shard_spec is not None:
        dist_tensor.dist_attr.mark_annotated("dims_mapping")
    default_dist_ctx = get_default_distributed_context()
    default_dist_ctx.add_dist_tensor_for_program(dist_tensor)
    dist_tensor = default_dist_ctx.get_dist_tensor_for_program(x)
    default_dist_ctx.add_process_mesh(process_mesh)
    return x


def shard_op(
    op, process_mesh=None, in_shard_specs=None, out_shard_specs=None, **kwargs
):
    """
    Shard an operation on a process mesh according to its input and output shard specification.

    Args:
        op (Callable): a callable operator or module to be sharded.
        process_mesh (ProcessMesh, optional): An instance of ProcessMesh describes a mesh
            topology of the used logical processes where the op is sharded. All of its inputs and
            outputs are sharded by this process mesh. If it is None, the found current process mesh
            will be used. And an error will be raised if the current process mesh cannot be found.
            Default: None.
        in_shard_specs (list of list, optional): a list of list to describe the sharding specifications
            for the inputs. Each item of `in_shard_specs` is a `shard_spec` between the corresponding input
            and `process_mesh`. If one item is None, the corresponding input is replicated across all processes
            If it is None, all inputs are replicated across all processes. Note that the length of the
            `in_shard_specs` should be equal to the actual number of inputs when calling this operation.
            Default: None.
        out_shard_specs (list of list, optional): a list of list to describe the sharding specifications
            for the outputs. Each item of `out_shard_specs` is a `shard_spec` between the corresponding output
            and `process_mesh`. If one item is None, the corresponding output is replicated across all processes
            If it is None, all outputs are replicated across all processes. Note that the length of the
            `in_shard_specs` should be equal to the actual number of inputs when calling this operation.
            Default: None. Default: None.

    Returns:
        Outputs of `op`, each of which is annotated with sharding information.

    Examples:
        .. code-block:: pycon

            >>> import paddle
            >>> from paddle.distributed.fleet import auto

            >>> x = paddle.ones([4, 6])
            >>> y = paddle.zeros([4, 6])
            >>> mesh = auto.ProcessMesh([[0, 1], [2, 3]], dim_names=["x", "y"])
            >>> dist_add = auto.shard_op(
            ...     paddle.add,
            ...     mesh,
            ...     in_shard_specs=[["x", "y"], ["y", None]],
            ...     out_shard_specs=[[None, "x"]],
            ... )
            >>> dist_add(x, y)

    """

    if process_mesh is not None:
        assert isinstance(process_mesh, ProcessMesh), (
            f"Argument process_mesh {process_mesh} is not an instance of ProcessMesh"
        )
    else:
        process_mesh = get_current_process_mesh()
        assert process_mesh is not None, (
            "Specify the process mesh argument or use ProcessMesh context manager first."
        )
    in_dims_mappings = []
    if in_shard_specs is not None:
        assert all(
            (isinstance(shard_spec, list) or shard_spec is None)
            for shard_spec in in_shard_specs
        ), f"in_shard_spec {in_shard_specs} is not a list of list or None"
        for shard_spec in in_shard_specs:
            if shard_spec is not None:
                in_dims_mappings.append(
                    convert_to_dims_mapping(shard_spec, process_mesh)
                )
            else:
                in_dims_mappings.append(None)
    out_dims_mappings = []
    if out_shard_specs is not None:
        assert all(
            (isinstance(shard_spec, list) or shard_spec is None)
            for shard_spec in out_shard_specs
        ), f"out_shard_spec {out_shard_specs} is not a list of list or None"
        for shard_spec in out_shard_specs:
            if shard_spec is not None:
                out_dims_mappings.append(
                    convert_to_dims_mapping(shard_spec, process_mesh)
                )
            else:
                out_dims_mappings.append(None)
    op = DistributedOperatorHelper(
        op, process_mesh, in_dims_mappings, out_dims_mappings, kwargs
    )
    return op


_g_recompute_idx = -1


def recompute(op):
    global _g_recompute_idx
    _g_recompute_idx += 1

    class RecomputeOperator:
        def __init__(self, op):
            self._op = op

        def __call__(self, *args, **kwargs):
            block = paddle.static.default_main_program().global_block()
            rc_begin_id = len(block.ops)

            with paddle.static.name_scope(
                f'/auto_parallel/rc_{_g_recompute_idx}'
            ):
                if paddle.base.dygraph.base.in_to_static_mode():
                    output = (
                        paddle.jit.dy2static.convert_call_func.convert_call(
                            self._op
                        )(*args, **kwargs)
                    )
                else:
                    output = self._op(*args, **kwargs)

            if paddle.framework.in_pir_mode():
                block = paddle.static.default_main_program().global_block()
                rc_end_id = len(block.ops)
                for idx in range(rc_begin_id, rc_end_id):
                    rc_op = block.ops[idx]
                    rc_op.set_int_attr("fwd_recompute_id", _g_recompute_idx)

            return output

    return RecomputeOperator(op)


def exclude_ops_in_recompute(run_function):
    """
    Exclude some operators in recompute segments.
        Args:
        run_function (callable): The callable function to be excluded.

    Returns:
        ExcludeOperator: The callable object.

    """

    class ExcludeOperator:
        def __init__(self, run_function):
            self._run_function = run_function

        def __call__(self, *args, **kwargs):
            with paddle.static.name_scope('/exclude_rc'):
                if paddle.base.dygraph.base.in_to_static_mode():
                    output = (
                        paddle.jit.dy2static.convert_call_func.convert_call(
                            self._run_function
                        )(*args, **kwargs)
                    )
                else:
                    output = self._run_function(*args, **kwargs)

            return output

    return ExcludeOperator(run_function)


_g_collections = {}


class CollectionNames:
    FETCHES = "fetches"
    LOGGING = "logging"


def get_collection(name):
    collection = _g_collections.get(name, None)
    if collection is None:
        collection = []
        _g_collections[name] = collection
    return _g_collections[name]


def add_to_collection(collection_name, value, name=None):
    if collection_name not in _g_collections:
        _g_collections[collection_name] = []
    if name is not None:
        for _, v in _g_collections[collection_name]:
            if v == value:
                return
        _g_collections[collection_name].append((name, value))
    else:
        for _, v in _g_collections[collection_name]:
            if v == value:
                return
        _g_collections[collection_name].append((None, value))


def fetch(tensor, name=None, logging=False):
    if isinstance(tensor, paddle.static.Variable):
        tensor = tensor.name
    elif isinstance(tensor, str):
        tensor = tensor
    else:
        raise TypeError(
            f"Only support fetch `Variable` or `str`[`Variable`'s name], but got `{type(tensor)}`"
        )
    add_to_collection(CollectionNames.FETCHES, tensor, name)
    if logging:
        add_to_collection(CollectionNames.LOGGING, tensor, name)


_g_mesh = None


def get_mesh() -> paddle.distributed.ProcessMesh:
    """
    Get the global mesh set by set_mesh.

    Returns:
        mesh (paddle.distributed.ProcessMesh): the global mesh.

    Examples:
        .. code-block:: pycon

            >>> import paddle
            >>> import paddle.distributed as dist
            >>> mesh = dist.ProcessMesh([[[0, 1], [2, 3]], [[4, 5], [6, 7]]], dim_names=["dp", "mp", "pp"])
            >>> # doctest: +REQUIRES(env:DISTRIBUTED)
            >>> dist.auto_parallel.set_mesh(mesh)
            >>> mesh = dist.auto_parallel.get_mesh()
            >>> # This case need to be executed in multi-card environment
            >>> # python -m paddle.distributed.launch --gpus=0,1,2,3,4,5,6,7 {test_case}.py
    """
    global _g_mesh
    return _g_mesh


def set_mesh(mesh: paddle.distributed.ProcessMesh) -> None:
    """
    Set the global mesh.

    Args:
        mesh (paddle.distributed.ProcessMesh): global mesh to be set.

    Returns:
        None

    Examples:
        .. code-block:: pycon

            >>> import paddle
            >>> import paddle.distributed as dist
            >>> mesh = dist.ProcessMesh([[[0, 1], [2, 3]], [[4, 5], [6, 7]]], dim_names=["dp", "mp", "pp"])
            >>> # doctest: +REQUIRES(env:DISTRIBUTED)
            >>> dist.auto_parallel.set_mesh(mesh)
            >>> # This case need to be executed in multi-card environment
            >>> # python -m paddle.distributed.launch --gpus=0,1,2,3,4,5,6,7 {test_case}.py
    """
    global _g_mesh
    _g_mesh = mesh


def create_mesh(mesh_dims: list[tuple[str, int]]):
    """
    Create a global process_mesh for auto parallel.

    Args:
        mesh_dims (list[tuple[str, int]]): A list of tuple, each element is (dim_name, dim_degree).
    """
    global _g_mesh
    dim_names = [mesh_dim[0] for mesh_dim in mesh_dims]
    mesh_shape = [mesh_dim[1] for mesh_dim in mesh_dims]
    mesh_arr = np.arange(0, reduce(lambda x, y: x * y, mesh_shape, 1)).reshape(
        mesh_shape
    )
    _g_mesh = ProcessMesh(mesh_arr, dim_names)
    return _g_mesh