mindspore 2.4.10__cp310-none-any.whl → 2.5.0__cp310-none-any.whl

mindspore/runtime/event.py

@@ -0,0 +1,209 @@
+# Copyright 2024 Huawei Technologies Co., Ltd
+#
+# 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.
+# ============================================================================
+"""Runtime event class"""
+from mindspore._c_expression import Event as Event_
+from mindspore._c_expression import Stream as Stream_
+from mindspore._c_expression import current_stream as current_stream_
+from mindspore import _checkparam as Validator
+from .device import _is_supported
+
+function_event_status = {'Event': False, 'wait': False}
+
+
+class Event(Event_):
+    r"""
+    Wrapper around a device event.
+
+    Device events are synchronization markers that can be used to monitor the device’s progress,
+    to accurately measure timing, and to synchronize device streams.
+
+    The underlying device events are lazily initialized when the event is first recorded.
+
+    Args:
+        enable_timing (bool, optional): indicates if the event should measure time (default: ``False``)
+        blocking (bool, optional): if ``True``, `wait` will be blocking (default: ``False``)
+
+    Supported Platforms:
+        ``Ascend`` ``GPU``
+
+    Examples:
+        >>> import mindspore as ms
+        >>> import numpy as np
+        >>> from mindspore import Tensor, ops
+        >>> ms.set_device("Ascend", 0)
+        >>> start = ms.runtime.Event(enable_timing=True)
+        >>> end = ms.runtime.Event(enable_timing=True)
+        >>> s1 = ms.runtime.Stream()
+        >>> s2 = ms.runtime.Stream()
+        >>> a = Tensor(np.ones([2, 2]), ms.float32)
+        >>> b = Tensor(np.ones([2, 2]), ms.float32)
+        >>> c = Tensor(np.ones([2, 2]), ms.float32)
+        >>> with ms.runtime.StreamCtx(s1):
+        ...     d = ops.matmul(a, b)
+        ...     start.record()
+        >>> c += 2
+        >>> end.record()
+        >>> with ms.runtime.StreamCtx(s2):
+        ...     start.synchronize()
+        ...     end.synchronize()
+        ...     e = c + d
+        >>> ms.runtime.synchronize()
+        >>> print(e)
+        [[5. 5.]
+         [5. 5.]]
+        >>> elapsed_time = start.elapsed_time(end)
+    """
+
+    def __init__(self, enable_timing=False, blocking=False):
+        if not function_event_status['Event']:
+            function_event_status['Event'] = True
+            if not _is_supported():
+                return
+        # pylint: disable=useless-super-delegation
+        Validator.check_bool(enable_timing, "enable_timing", "Event")
+        Validator.check_bool(blocking, "blocking", "Event")
+        super().__init__(enable_timing, blocking)
+
+    def record(self, stream=None):
+        r"""
+        Records the event in a given stream.
+
+        Uses :func:`mindspore.runtime.current_stream()` if no `stream` is specified. The
+        stream's device must match the event's device.
+
+        Args:
+            stream (Stream, optional): a stream to record. If this argument is ``None``,
+                current stream will be used. Default value: ``None``.
+
+        Raises:
+            TypeError: If 'stream' is neither a :class:`mindspore.runtime.Stream` nor a ``None``.
+        """
+        if stream is None:
+            stream = current_stream_()
+        if not isinstance(stream, Stream_):
+            raise TypeError(
+                f"For 'record', the argument 'stream' should be Stream,"
+                f" but got {type(stream)}."
+            )
+        super().record(stream)
+
+    def wait(self, stream=None):
+        r"""
+        Makes all future work submitted to the given stream wait for this
+        event.
+
+        Use :func:`mindspore.runtime.current_stream()` if no `stream` is specified.
+
+        Args:
+            stream (Stream, optional): a stream to record. If this argument is ``None``,
+                current stream will be used. Default value: ``None``.
+
+        Raises:
+            TypeError: If 'stream' is neither a :class:`mindspore.runtime.Stream` nor a ``None``.
+
+        Supported Platforms:
+            ``Ascend`` ``GPU``
+
+        Examples:
+            >>> import mindspore as ms
+            >>> import numpy as np
+            >>> from mindspore import Tensor, ops
+            >>> ms.set_device("Ascend", 0)
+            >>> event = ms.runtime.Event()
+            >>> s1 = ms.runtime.Stream()
+            >>> s2 = ms.runtime.Stream()
+            >>> a = Tensor(np.ones([2, 2]), ms.float32)
+            >>> b = Tensor(np.ones([2, 2]), ms.float32)
+            >>> with ms.runtime.StreamCtx(s1):
+            ...     c = ops.matmul(a, b)
+            ...     event.record()
+            >>> event.wait()
+            >>> d = c + 2
+            >>> ms.runtime.synchronize()
+            >>> print(d)
+            [[4. 4.]
+             [4. 4.]]
+        """
+        if not function_event_status['wait']:
+            function_event_status['wait'] = True
+            if not _is_supported():
+                return
+        if stream is None:
+            stream = current_stream_()
+        if not isinstance(stream, Stream_):
+            raise TypeError(
+                f"For 'wait', the argument 'stream' should be Stream,"
+                f" but got {type(stream)}."
+            )
+        super().wait(stream)
+
+    def synchronize(self):
+        r"""
+        Waits for the event to complete.
+
+        Waits until the completion of all work currently captured in this event.
+        This prevents the CPU thread from proceeding until the event completes.
+        """
+        # pylint: disable=useless-super-delegation
+        super().synchronize()
+
+    def query(self):
+        r"""
+        Checks if all work currently captured by event has completed.
+
+        Returns:
+            A boolean indicating if all work currently captured by event has completed.
+
+        Supported Platforms:
+            ``Ascend`` ``GPU``
+
+        Examples:
+            >>> import mindspore as ms
+            >>> import numpy as np
+            >>> from mindspore import Tensor, ops
+            >>> ms.set_device("Ascend", 0)
+            >>> a = Tensor(np.ones([1024, 2048]), ms.float32)
+            >>> b = Tensor(np.ones([2048, 4096]), ms.float32)
+            >>> s1 = ms.runtime.Stream()
+            >>> with ms.runtime.StreamCtx(s1):
+            ...     c = ops.matmul(a, b)
+            ...     ev = s1.record_event()
+            >>> s1.synchronize()
+            >>> assert ev.query()
+        """
+        # pylint: disable=useless-super-delegation
+        return super().query()
+
+    def elapsed_time(self, end_event):
+        r"""
+        Returns the time elapsed in milliseconds after the event was
+        recorded and before the end_event was recorded.
+
+        Args:
+            end_event (Event): end event.
+
+        Returns:
+            float, the time elapsed in milliseconds.
+
+        Raises:
+            TypeError: If 'end_event' is not a :class:`mindspore.runtime.Event`.
+        """
+        # pylint: disable=useless-super-delegation
+        if not isinstance(end_event, Event):
+            raise TypeError(
+                f"For 'elapsed_time', the argument 'end_event' should be Event,"
+                f" but got {type(end_event)}."
+            )
+        return super().elapsed_time(end_event)

mindspore/runtime/executor.py

@@ -0,0 +1,148 @@
+# Copyright 2024 Huawei Technologies Co., Ltd
+#
+# 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.
+# ============================================================================
+
+"""Executor manager interfaces."""
+from mindspore._c_expression import RuntimeConf
+from mindspore.runtime.thread_bind_core import _get_cpu_affinity_policy
+from mindspore._checkparam import args_type_check
+from mindspore import _checkparam as Validator
+from mindspore import log as logger
+
+
+
+def launch_blocking():
+    """
+    Whether to enable synchronous execution.
+    Default: ``False`` . When the value is set to ``False`` , the operator is executed asynchronously on the
+    device. When an error occurs in the execution of the operator, the specific error script code location
+    cannot be located. When this API is called , the value will be changed to true, the operator is executed
+    synchronously on the device. It will reduce the execution performance of the program. At this time, when
+    an error occurs in the execution of the operator, the location of the error script code can be located
+    according to the call stack of the error.
+
+    Note:
+        - No parameters are required.
+        - By default, operations are executed asynchronously.
+        - Calling this function enables synchronous execution.
+
+    Examples:
+        >>> import mindspore as ms
+        >>> ms.set_device("Ascend", 1)
+        >>> ms.runtime.launch_blocking()
+    """
+    return RuntimeConf.get_instance().set_launch_blocking()
+
+
+@args_type_check(threads_num=int)
+def dispatch_threads_num(threads_num):
+    """
+    Set the threads number of runtime used.
+
+    The framework set the runtime number of threads are 5 by default.
+
+    Args:
+        threads_num (int): The threads number of runtime used.
+
+    Examples:
+        >>> import mindspore as ms
+        >>> ms.set_device("Ascend", 1)
+        >>> ms.runtime.dispatch_threads_num(6)
+    """
+    if RuntimeConf.get_instance().is_dispatch_threads_num_configured():
+        raise RuntimeError("The 'dispatch_threads_num' can not be set repeatedly.")
+
+    threads_num = Validator.check_positive_int(threads_num, "threads_num")
+
+    return RuntimeConf.get_instance().set_dispatch_threads_num(threads_num)
+
+
+@args_type_check(enable_affinity=bool, affinity_cpu_list=dict)
+def set_cpu_affinity(enable_affinity, affinity_cpu_list=None):
+    """
+    Enable thread-level core binding to assign specific CPU cores to MindSpore's main modules (main thread, pynative,
+    runtime, minddata), to prevent unstable performance caused by MindSpore's threads seizing CPU.
+
+    Note:
+        - Provides two binding modes: 1. Automatically generates binding policies based on available CPUs, NUMA nodes,
+          and device resources in the environment to bind cores at thread level. 2. Thread-level bonding based on
+          customized bonding policies passed in by `affinity_cpu_list`.
+
+        - The automated bind-core policy generation scenario invokes system commands to obtain CPU, NUMA node, and
+          device resources on the environment, and some commands cannot be executed successfully due to environment
+          differences; the automated bind-core policy generated will vary according to the resources available on the
+          environment:
+
+          1. `cat /sys/fs/cgroup/cpuset/cpuset.cpus`, to obtain the available CPU resources on the environment; if the
+             execution of this command fails, the bind-core function will not take effect.
+          2. `npu-smi info -m`, get the available NPU resources on the environment; if the execution of this command
+             fails, the bind-core policy will be generated only based on the available CPU resources,
+             without considering the device affinity.
+          3. `npu-smi info -t board -i {NPU_ID} -c {CHIP_ID}`, get NPU details based on the logical ID of the device;
+             if the execution of this command fails, the bind-core policy is generated based on the available CPU
+             resources only, regardless of device affinity.
+          4. `lspci -s {PCIe_No} -vvv`, get the hardware information of the device on the environment; if the execution
+             of this command fails, the bind-core policy is generated only based on the available CPU resources,
+             without considering the device affinity.
+          5. `lscpu`, get information about CPUs and NUMA nodes on the environment; if the execution of this command
+             fails, only the available CPU resources are used to generate the bind-core policy, without considering
+             the device affinity.
+
+    Args:
+        enable_affinity (bool): Switches on/off thread-level core binding.
+        affinity_cpu_list (dict, optional): Specifies a customized bind-core policy. The key to be passed
+            into the dict needs to be in string ``"deviceX"`` format, and the value needs to be in list
+            ``["cpuidX-cpuidY"]`` format. Default: ``None``, i.e., use the bind-core policy generated automatically
+            based on the environment. It is allowed to pass the empty dict ``{}``, in which case the bind-core
+            policy generated automatically based on the environment will be used.
+
+    Raises:
+        TypeError: The parameter `enable_affinity` is not a boolean.
+        TypeError: The parameter `affinity_cpu_list` is neither a dictionary nor a ``None``.
+        ValueError: The key of parameter `affinity_cpu_list` is not a string.
+        ValueError: The key of parameter `affinity_cpu_list` is not in ``"deviceX"`` format.
+        ValueError: The parameter `affinity_cpu_list` has a value that is not a list.
+        ValueError: The element in value of parameter `affinity_cpu_list` is not a string.
+        ValueError: The element in value for parameter `affinity_cpu_list` does not match ``["cpuidX-cpuidY"]``.
+        RuntimeError: Automatically generated binding policy or customized binding policy scenario where the number
+            of CPU cores assigned to each device is less than 7.
+        RuntimeError: A custom-specified binding policy scenario where the CPU assigned to a device is not
+            available in the environment.
+        RuntimeError: The `mindspore.runtime.set_cpu_affinity` API is called repeatedly.
+
+    Examples:
+        >>> import mindspore as ms
+        >>> ms.set_device("Ascend", 1)
+        >>> ms.runtime.set_cpu_affinity(True)
+        >>>
+        >>> import mindspore as ms
+        >>> ms.set_device("Ascend", 1)
+        >>> ms.runtime.set_cpu_affinity(True, {"device0":["0-9"],"device1":["10-15","20-29"],"device2":["35-45"]})
+    """
+    if RuntimeConf.get_instance().is_thread_bind_core_configured():
+        raise RuntimeError("The 'mindspore.runtime.set_cpu_affinity' cannot be set repeatedly.")
+    if enable_affinity:
+        module_bind_core_policy, bind_policy_flag = _get_cpu_affinity_policy(affinity_cpu_list)
+        if not module_bind_core_policy:
+            logger.warning("set_cpu_affinity is not enabled because the environment does not meet the "
+                           "basic conditions for binding core.")
+            RuntimeConf.get_instance().set_thread_bind_core_configured()
+            return
+        if bind_policy_flag:
+            RuntimeConf.get_instance().thread_bind_core_with_policy(module_bind_core_policy)
+        else:
+            RuntimeConf.get_instance().thread_bind_core(module_bind_core_policy)
+    else:
+        RuntimeConf.get_instance().set_thread_bind_core_configured()
+        return