mindspore 2.1.0__cp38-cp38-win_amd64.whl → 2.2.11__cp38-cp38-win_amd64.whl

mindspore/rewrite/api/node.py

@@ -14,12 +14,13 @@
 # ============================================================================
 """Rewrite module api: Node."""
 
-from typing import Union, Optional
+from typing import Union, Optional, List, Dict
+from types import FunctionType
 
 from mindspore.nn import Cell
 from mindspore.ops.primitive import Primitive
 from mindspore import _checkparam as Validator
-from ..node import Node as NodeImpl
+from ..node.node import Node as NodeImpl
 from ..symbol_tree import SymbolTree as SymbolTreeImpl
 from .node_type import NodeType
 from .scoped_value import ScopedValue
@@ -50,8 +51,8 @@ class Node:
         return self._node == other._node
 
     @staticmethod
-    def create_call_cell(cell: Cell, targets: [Union[ScopedValue, str]], args: [ScopedValue] = None,
-                         kwargs: {str: ScopedValue}=None, name: str = "", is_sub_net: bool = False) -> 'Node':
+    def create_call_cell(cell: Cell, targets: List[Union[ScopedValue, str]], args: List[ScopedValue] = None,
+                         kwargs: Dict[str, ScopedValue] = None, name: str = "", is_sub_net: bool = False) -> 'Node':
         """
         Create a node. Only support create from a `Cell` now.
 
@@ -63,14 +64,15 @@ class Node:
 
         Args:
             cell (Cell): Cell-operator of this forward-layer.
-            targets (list[ScopedValue]): Indicate output names. Used as targets of an assign statement in source code.
-            args (list[ScopedValue]): Indicate input names. Used as args of a call expression of an assign statement in
+            targets (List[Union[ScopedValue, str]]): Indicate output names. Used as targets of an assign statement in
+                source code.
+            args (List[ScopedValue]): Indicate input names. Used as args of a call expression of an assign statement in
                 source code. Default: ``None`` , which indicates the `cell` has no args inputs.
-            kwargs (dict): Type of key must be `str` and type of value must be `ScopedValue`.
+            kwargs (Dict[str, ScopedValue]): Type of key must be `str` and type of value must be `ScopedValue`.
                 Indicate keyword input names. Used as kwargs of a call expression of an assign statement in source
                 code. Default: ``None`` , which indicates the `cell` has no kwargs inputs.
             name (str): Indicate the name of node. Used as field name in source code. Default is None. Rewrite will
-                generate name from `targets` when name is None. Rewrite will check and ensure the uniqueness of `name`
+                generate name from `cell` when name is None. Rewrite will check and ensure the uniqueness of `name`
                 while node being inserted. Default: ``""`` .
             is_sub_net (bool): Indicate that is `cell` a network. If `is_sub_net` is true, Rewrite will try to parse
                 the `cell` to a TreeNode, otherwise the `cell` is parsed to a CallCell node. Default: ``False`` .
@@ -89,7 +91,7 @@ class Node:
             >>> from mindspore.rewrite import SymbolTree, ScopedValue
             >>> import mindspore.nn as nn
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("conv1")
@@ -108,8 +110,66 @@ class Node:
             Validator.check_element_type_of_iterable("args", args, [ScopedValue], "Node")
         if kwargs is not None:
             Validator.check_element_type_of_dict("kwargs", kwargs, [str], [ScopedValue], "Node")
-        return Node(NodeImpl.create_call_op(cell, None, targets, ScopedValue.create_naming_value(name, "self"),
-                                            args, kwargs, name, is_sub_net))
+        return Node(NodeImpl.create_call_op(cell, None, targets, args, kwargs, name, is_sub_net))
+
+    @staticmethod
+    def create_call_function(function: FunctionType, targets: List[Union[ScopedValue, str]],
+                             args: List[ScopedValue] = None, kwargs: Dict[str, ScopedValue] = None) -> 'Node':
+        """
+        Create a node that corresponds to a function call. The `function` object is saved into network, and used via
+        getting object from `self.` .
+
+        Args:
+            function (FunctionType): The function to be called.
+            targets (List[Union[ScopedValue, str]]): indicates output names. Used as targets of an assign statement in
+                source code.
+            args (List[ScopedValue]): Indicate input names. Used as args of a call expression of an assign statement in
+                source code. Default: ``None`` , which indicates the `function` has no args inputs.
+            kwargs (Dict[str, ScopedValue]): Type of key must be `str` and type of value must be `ScopedValue`.
+                Indicate keyword input names. Used as kwargs of a call expression of an assign statement in source
+                code. Default: ``None`` , which indicates the `function` has no kwargs inputs.
+
+        Returns:
+            An instance of `Node`.
+
+        Raises:
+            TypeError: If `function` is not a `FunctionType`.
+            TypeError: If `targets` is not `list`.
+            TypeError: If the type of `targets` is not in `[ScopedValue, str]`.
+            TypeError: If arg in `args` is not a `ScopedValue`.
+            TypeError: If key of `kwarg` is not a str or value of kwarg in `kwargs` is not a `ScopedValue`.
+
+        Examples:
+            >>> from mindspore.rewrite import SymbolTree, ScopedValue
+            >>> import mindspore.nn as nn
+            >>> import mindspore.ops as ops
+            >>> # Define the network structure of LeNet5. Refer to
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
+            >>> net = LeNet5()
+            >>> stree = SymbolTree.create(net)
+            >>> node = stree.get_node("conv1")
+            >>> position = stree.after(node)
+            >>> new_node = node.create_call_function(function=ops.abs, targets=['x'],
+            ...                                      args=[ScopedValue.create_naming_value('x')])
+            >>> stree.insert(position, new_node)
+            >>> print(new_node.get_node_type())
+            NodeType.CallFunction
+        """
+        Validator.check_value_type("function", function, [FunctionType, type], "create_call_function")
+        Validator.check_element_type_of_iterable("targets", targets, [ScopedValue, str], "create_call_function")
+        if args is not None:
+            Validator.check_element_type_of_iterable("args", args, [ScopedValue], "create_call_function")
+        if kwargs is not None:
+            Validator.check_element_type_of_dict("kwargs", kwargs, [str], [ScopedValue], "create_call_function")
+        return Node(NodeImpl._create_call_function(function, targets, args, kwargs))
+
+    @staticmethod
+    def create_input(param_name: str, default: Optional[ScopedValue] = None) -> 'Node':
+    # pylint: disable=missing-function-docstring
+        Validator.check_value_type("param_name", param_name, [str], "Node")
+        if default is not None:
+            Validator.check_value_type("default", default, [ScopedValue], "Node")
+        return Node(NodeImpl.create_input_node(None, param_name, default, name=f"input_{param_name}"))
 
     def get_handler(self) -> NodeImpl:
         return self._node
@@ -124,7 +184,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("conv2")
@@ -144,7 +204,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("conv1")
@@ -177,7 +237,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("relu_3")
@@ -216,7 +276,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> src_node = stree.get_node("fc1")
@@ -256,7 +316,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("conv1")
@@ -276,7 +336,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("conv1")
@@ -303,7 +363,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("conv1")
@@ -326,7 +386,7 @@ class Node:
         Examples:
             >>> from mindspore.rewrite import SymbolTree
             >>> # Define the network structure of LeNet5. Refer to
-            >>> # https://gitee.com/mindspore/docs/blob/r2.1/docs/mindspore/code/lenet.py
+            >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
             >>> net = LeNet5()
             >>> stree = SymbolTree.create(net)
             >>> node = stree.get_node("conv1")
@@ -335,6 +395,29 @@ class Node:
         """
         return self._node.get_args()
 
+    def get_symbol_tree(self) -> 'SymbolTree':
+        """
+        Get the symbol tree which current node belongs to.
+
+        Returns:
+            SymbolTree, None if current node does not belong to any SymbolTree.
+
+        Examples:
+        >>> from mindspore.rewrite import SymbolTree
+        >>> # Define the network structure of LeNet5. Refer to
+        >>> # https://gitee.com/mindspore/docs/blob/r2.2/docs/mindspore/code/lenet.py
+        >>> net = LeNet5()
+        >>> stree = SymbolTree.create(net)
+        >>> node = stree.get_node("conv1")
+        >>> print(type(node.get_symbol_tree()))
+        <class 'mindspore.rewrite.api.symbol_tree.SymbolTree'>
+        """
+        from .symbol_tree import SymbolTree
+        stree_impl = self._node.get_belong_symbol_tree()
+        if not stree_impl:
+            return None
+        return SymbolTree(stree_impl)
+
     def get_kwargs(self) -> {str: ScopedValue}:
         return self._node.get_kwargs()
 

mindspore/rewrite/api/node_type.py

@@ -23,14 +23,17 @@ class NodeType(Enum):
     - Unknown: Not inited NodeType.
     - CallCell: `CallCell` node represents invoking cell-op in forward method.
     - CallPrimitive: `CallPrimitive` node represents invoking primitive-op in forward method.
-    - CallFunction: `CallFunction` node represents invoking mindspore function in forward method.
+    - CallFunction: `CallFunction` node represents invoking a function in forward method.
     - CallMethod: `CallMethod` node represents invoking of method in forward method which can not be mapped to
       cell-op or primitive-op in MindSpore.
     - Python: `Python` node holds unsupported-ast-node or unnecessary-to-parse-ast-node.
     - Input: `Input` node represents input of `SymbolTree` corresponding to arguments of forward method.
     - Output: `Output` node represents output of SymbolTree corresponding to return statement of forward method.
     - Tree: `Tree` node represents sub-network invoking in forward method.
+    - CellContainer: `CellContainer` node represents invoking method :class:`mindspore.nn.SequentialCell` in
+      forward method.
     - MathOps: `MathOps` node represents a mathematical operation, such as adding or comparing in forward method.
+    - ControlFlow: `ControlFlow` node represents a control flow statement, such as if statement.
 
     """
     Unknown = 0
@@ -47,3 +50,4 @@ class NodeType(Enum):
     Tree = 9
     CellContainer = 10
     MathOps = 11
+    ControlFlow = 12

mindspore/rewrite/api/pattern_engine.py

@@ -364,7 +364,7 @@ class PatternEngine:
                 continue
             if cur_node.get_node_type() == NodeType.Tree:
                 subtree = TreeNodeHelper.get_sub_tree(cur_node)
-                self.apply(subtree)
+                _ = self.apply(subtree)
                 visited.append(cur_node)
                 queue.extend(cur_node.get_users())
                 continue

mindspore/rewrite/api/scoped_value.py

@@ -14,7 +14,7 @@
 # ============================================================================
 """Rewrite module api: ValueType and ScopedValue."""
 from enum import Enum
-from typing import Optional, Union
+from typing import Optional, Union, List, Tuple
 from mindspore import _checkparam as Validator
 
 
@@ -28,10 +28,7 @@ class ValueType(Enum):
     """
 
     # base type
-    StringValue = 0
-    IntValue = 1
-    FloatValue = 2
-    NoneValue = 3
+    ConstantValue = 0
     # container type
     TupleValue = 20
     ListValue = 21
@@ -82,14 +79,8 @@ class ScopedValue:
             >>> print(variable)
             2
         """
-        if value is None:
-            return cls(ValueType.NoneValue, "", value)
-        if isinstance(value, int):
-            return cls(ValueType.IntValue, "", value)
-        if isinstance(value, float):
-            return cls(ValueType.FloatValue, "", value)
-        if isinstance(value, str):
-            return cls(ValueType.StringValue, "", value)
+        if isinstance(value, (type(None), int, float, str, bool)):
+            return cls(ValueType.ConstantValue, "", value)
         if isinstance(value, tuple):
             return cls(ValueType.TupleValue, "",
                        tuple(cls.create_variable_value(single_value) for single_value in value))
@@ -130,13 +121,14 @@ class ScopedValue:
         return cls(ValueType.NamingValue, scope, name)
 
     @staticmethod
-    def create_name_values(names: Union[list, tuple], scopes: Union[list, tuple] = None) -> ['ScopedValue']:
+    def create_name_values(names: Union[List[str], Tuple[str]],
+                           scopes: Union[List[str], Tuple[str]] = None) -> List['ScopedValue']:
         """
         Create a list of naming `ScopedValue`.
 
         Args:
-            names (list[str] or tuple[str]): List or tuple of `str` represents names of referenced variables.
-            scopes (list[str] or tuple[str]): List or tuple of `str` represents scopes of referenced variables.
+            names (List[str] or Tuple[str]): List or tuple of `str` represents names of referenced variables.
+            scopes (List[str] or Tuple[str]): List or tuple of `str` represents scopes of referenced variables.
                 Default: ``None`` .
 
         Returns:
@@ -168,7 +160,7 @@ class ScopedValue:
         return result
 
     def __str__(self):
-        if self.type in (ValueType.IntValue, ValueType.FloatValue, ValueType.StringValue):
+        if self.type == ValueType.ConstantValue:
             return str(self.value)
         if self.type == ValueType.NamingValue:
             return f"{self.scope}.{self.value}" if self.scope else str(self.value)