chiwwang commented on a change in pull request #8220: URL: https://github.com/apache/tvm/pull/8220#discussion_r660231625
########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. +# +# Note that ``exit_pass_ctx`` of ``PassTimingInstrument`` is called. +# Profiles are cleared so nothing is printed. +cur_pass_ctx.override_instruments([]) +# Uncomment the call to .render() to see a warning like: +# Warning: no passes have been profiled, did you enable pass profiling? +# profiles = timing_inst.render() + + +############################################################################### +# Create Customized Instrument Class +# ---------------------------------- +# A customized instrument class can be easily created by +# :py:func:`tvm.instrument.pass_instrument` decorator. +# +# Let's create an instrument class which calculate the difference of ``CallNode`` +# counting per ``op.name`` before and after passes. + +# decorate the class +@pass_instrument +class RelayCallNodeDiffer: + def __init__(self): + self._op_diff = [] + # Passes can be nested. + # Use stack to make sure we get correct before/after pairs. + self._op_cnt_before_stack = [] + + def enter_pass_ctx(self): + self._op_diff = [] + self._op_cnt_before_stack = [] + + def exit_pass_ctx(self): + assert len(self._op_cnt_before_stack) == 0, "The stack is not empty. Something wrong." + + def run_before_pass(self, mod, info): + self._op_cnt_before_stack.append((info.name, self._count_nodes(mod))) + + def run_after_pass(self, mod, info): + # Pop out the latest recorded pass. + name_before, op_to_cnt_before = self._op_cnt_before_stack.pop() + assert name_before == info.name, "name_before: {}, info.name: {} doesn't match".format( + name_before, info.name + ) + cur_depth = len(self._op_cnt_before_stack) + op_to_cnt_after = self._count_nodes(mod) + op_diff = self._diff(op_to_cnt_after, op_to_cnt_before) + # only record passes causing differences. + if op_diff: + self._op_diff.append((cur_depth, info.name, op_diff)) + + def get_pass_to_op_diff(self): + """ + return [ + (depth, pass_name, {op_name: diff_num, ...}), ... + ] + """ + return self._op_diff + + @staticmethod + def _count_nodes(mod): + ret = {} + + def visit(node): + if isinstance(node, relay.expr.Call): + try: + op_name = node.op.name + except AttributeError: + # Some CallNode may not have 'name' such as relay.Function + return + try: + ret[op_name] += 1 + except KeyError: + ret[op_name] = 1 + + relay.analysis.post_order_visit(mod["main"], visit) + return ret + + @staticmethod + def _diff(d_after, d_before): + # d_after - d_before + ret = {} + key_after, key_before = set(d_after), set(d_before) + for k in key_before & key_after: + tmp = d_after[k] - d_before[k] + if tmp: + ret[k] = d_after[k] - d_before[k] + for k in key_after - key_before: + ret[k] = d_after[k] + for k in key_before - key_after: + ret[k] = -d_before[k] + return ret + + +############################################################################### +# Apply Passes and Multiple Instrument Classes +# -------------------------------------------- +# Apply any pass you wish. Here :py:class:`tvm.relay.transform.ConvertLayout` +# and :py:class:`tvm.relay.transform.FoldConstant` are used. +# +# ``ConvertLayout`` might add ``layout_transform`` Op while ``FoldConstant`` can +# reduce the number of ``CallNode``. +# +# We can also use multiple instrument classes in a ``PassContext``. +# However, it should be noted that instrument methods are executed sequentially, +# obeying the order of ``instruments`` argument. +# So for instrument classes like ``PassTimingInstrument``, it is inevitable to +# count-up the execution time of other instrument classes to the final +# profile result. +call_node_inst = RelayCallNodeDiffer() +desired_layouts = { + "nn.conv2d": ["NHWC", "HWIO"], +} +# Because layout_transform may be added as a successor of Constant, +# we run FoldConstant twice. +# Though it is obvious only the FoldConstant after the ConvertLayout matter, +# we want to show how many layout_transform is added as a successor of +# Constant. +pass_seq = tvm.transform.Sequential( + [ + relay.transform.FoldConstant(), + relay.transform.ConvertLayout(desired_layouts), + relay.transform.FoldConstant(), + ] +) +# bind parameters to make VarNode as ConstantNode. +relay_mod["main"] = bind_params_by_name(relay_mod["main"], relay_params) +# timing_inst is put after call_node_inst. +# So the execution time of ``call_node.inst.run_after_pass()`` is also counted. +with tvm.transform.PassContext(opt_level=3, instruments=[call_node_inst, timing_inst]): + relay_mod = pass_seq(relay_mod) + profiles = timing_inst.render() +# Uncomment the next line to see timing-profile results. +# print(profiles) + + +############################################################################### +# We can see how many CallNode increase/decrease per op type. +from pprint import pprint + +pprint(call_node_inst.get_pass_to_op_diff()) + + +############################################################################### +# Exception Handling +# ------------------ +# Let's see what happen if exceptions occur in each methods of a ``PassInstrument``. +# +# Define ``PassInstrument`` classes which raise exceptions in enter/exit ``PassContext``: +class PassExampleBase: + def __init__(self, name): + self._name = name + + def enter_pass_ctx(self): + print(self._name, "enter_pass_ctx") + + def exit_pass_ctx(self): + print(self._name, "exit_pass_ctx") + + def should_run(self, mod, info): + print(self._name, "should_run") + return True + + def run_before_pass(self, mod, pass_info): + print(self._name, "run_before_pass") + + def run_after_pass(self, mod, pass_info): + print(self._name, "run_after_pass") + + +@pass_instrument +class PassFine(PassExampleBase): + pass + + +@pass_instrument +class PassBadEnterCtx(PassExampleBase): + def enter_pass_ctx(self): + print(self._name, "bad enter_pass_ctx!!!") + raise ValueError("{} bad enter_pass_ctx".format(self._name)) + + +@pass_instrument +class PassBadExitCtx(PassExampleBase): + def exit_pass_ctx(self): + print(self._name, "bad exit_pass_ctx!!!") + raise ValueError("{} bad exit_pass_ctx".format(self._name)) + + +############################################################################### +# If an exception occur in ``enter_pass_ctx``, ``PassContext`` disable the pass +# instrumentation. And it will run ``exit_pass_ctx`` of each ``PassInstrument`` +# which successfully finished ``enter_pass_ctx``. +# +# In following example, we can see ``exit_pass_ctx`` of `PassFine_0` is executed after exception. +demo_ctx = tvm.transform.PassContext( + instruments=[ + PassFine("PassFine_0"), + PassBadEnterCtx("PassBadEnterCtx"), + PassFine("PassFine_1"), + ] +) +try: + with demo_ctx: + relay_mod = relay.transform.InferType()(relay_mod) +except ValueError as ex: + print("Catching", str(ex).split("\n")[-1]) + +############################################################################### +# Also, all ``PassInstrument`` are cleared. +# So nothing printed while ``override_instruments`` is called. +demo_ctx.override_instruments([]) # no PassFine_0 exit_pass_ctx printed....etc + +############################################################################### +# If an exception occur in ``exit_pass_ctx``, pass instrumentation is disabled. +# Then exception is thrown. That means ``PassInstrument`` registered +# after the one throwing the exception do not execute ``exit_pass_ctx``. +demo_ctx = tvm.transform.PassContext( + instruments=[ + PassFine("PassFine_0"), + PassBadExitCtx("PassBadExitCtx"), + PassFine("PassFine_1"), + ] +) +try: + # PassFine_1 execute enter_pass_ctx, but not exit_pass_ctx. + with demo_ctx: + relay_mod = relay.transform.InferType()(relay_mod) +except ValueError as ex: + print("Catching", str(ex).split("\n")[-1]) + +############################################################################### +# Exceptions occured in ``should_run``, ``run_before_pass``, ``run_after_pass`` +# are not handled explicitly -- that means, we rely on the context manager Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. +# +# Note that ``exit_pass_ctx`` of ``PassTimingInstrument`` is called. +# Profiles are cleared so nothing is printed. +cur_pass_ctx.override_instruments([]) +# Uncomment the call to .render() to see a warning like: +# Warning: no passes have been profiled, did you enable pass profiling? +# profiles = timing_inst.render() + + +############################################################################### +# Create Customized Instrument Class +# ---------------------------------- +# A customized instrument class can be easily created by +# :py:func:`tvm.instrument.pass_instrument` decorator. +# +# Let's create an instrument class which calculate the difference of ``CallNode`` +# counting per ``op.name`` before and after passes. + +# decorate the class +@pass_instrument +class RelayCallNodeDiffer: + def __init__(self): + self._op_diff = [] + # Passes can be nested. + # Use stack to make sure we get correct before/after pairs. + self._op_cnt_before_stack = [] + + def enter_pass_ctx(self): + self._op_diff = [] + self._op_cnt_before_stack = [] + + def exit_pass_ctx(self): + assert len(self._op_cnt_before_stack) == 0, "The stack is not empty. Something wrong." + + def run_before_pass(self, mod, info): + self._op_cnt_before_stack.append((info.name, self._count_nodes(mod))) + + def run_after_pass(self, mod, info): + # Pop out the latest recorded pass. + name_before, op_to_cnt_before = self._op_cnt_before_stack.pop() + assert name_before == info.name, "name_before: {}, info.name: {} doesn't match".format( + name_before, info.name + ) + cur_depth = len(self._op_cnt_before_stack) + op_to_cnt_after = self._count_nodes(mod) + op_diff = self._diff(op_to_cnt_after, op_to_cnt_before) + # only record passes causing differences. + if op_diff: + self._op_diff.append((cur_depth, info.name, op_diff)) + + def get_pass_to_op_diff(self): + """ + return [ + (depth, pass_name, {op_name: diff_num, ...}), ... + ] + """ + return self._op_diff + + @staticmethod + def _count_nodes(mod): + ret = {} + + def visit(node): + if isinstance(node, relay.expr.Call): + try: + op_name = node.op.name + except AttributeError: + # Some CallNode may not have 'name' such as relay.Function + return + try: + ret[op_name] += 1 + except KeyError: + ret[op_name] = 1 + + relay.analysis.post_order_visit(mod["main"], visit) + return ret + + @staticmethod + def _diff(d_after, d_before): + # d_after - d_before + ret = {} + key_after, key_before = set(d_after), set(d_before) + for k in key_before & key_after: + tmp = d_after[k] - d_before[k] + if tmp: + ret[k] = d_after[k] - d_before[k] + for k in key_after - key_before: + ret[k] = d_after[k] + for k in key_before - key_after: + ret[k] = -d_before[k] + return ret + + +############################################################################### +# Apply Passes and Multiple Instrument Classes +# -------------------------------------------- +# Apply any pass you wish. Here :py:class:`tvm.relay.transform.ConvertLayout` +# and :py:class:`tvm.relay.transform.FoldConstant` are used. +# +# ``ConvertLayout`` might add ``layout_transform`` Op while ``FoldConstant`` can +# reduce the number of ``CallNode``. +# +# We can also use multiple instrument classes in a ``PassContext``. +# However, it should be noted that instrument methods are executed sequentially, +# obeying the order of ``instruments`` argument. +# So for instrument classes like ``PassTimingInstrument``, it is inevitable to +# count-up the execution time of other instrument classes to the final +# profile result. +call_node_inst = RelayCallNodeDiffer() +desired_layouts = { + "nn.conv2d": ["NHWC", "HWIO"], +} +# Because layout_transform may be added as a successor of Constant, +# we run FoldConstant twice. +# Though it is obvious only the FoldConstant after the ConvertLayout matter, +# we want to show how many layout_transform is added as a successor of +# Constant. +pass_seq = tvm.transform.Sequential( + [ + relay.transform.FoldConstant(), + relay.transform.ConvertLayout(desired_layouts), + relay.transform.FoldConstant(), + ] +) +# bind parameters to make VarNode as ConstantNode. +relay_mod["main"] = bind_params_by_name(relay_mod["main"], relay_params) +# timing_inst is put after call_node_inst. +# So the execution time of ``call_node.inst.run_after_pass()`` is also counted. +with tvm.transform.PassContext(opt_level=3, instruments=[call_node_inst, timing_inst]): + relay_mod = pass_seq(relay_mod) + profiles = timing_inst.render() +# Uncomment the next line to see timing-profile results. +# print(profiles) + + +############################################################################### +# We can see how many CallNode increase/decrease per op type. +from pprint import pprint + +pprint(call_node_inst.get_pass_to_op_diff()) + + +############################################################################### +# Exception Handling +# ------------------ +# Let's see what happen if exceptions occur in each methods of a ``PassInstrument``. +# +# Define ``PassInstrument`` classes which raise exceptions in enter/exit ``PassContext``: +class PassExampleBase: + def __init__(self, name): + self._name = name + + def enter_pass_ctx(self): + print(self._name, "enter_pass_ctx") + + def exit_pass_ctx(self): + print(self._name, "exit_pass_ctx") + + def should_run(self, mod, info): + print(self._name, "should_run") + return True + + def run_before_pass(self, mod, pass_info): + print(self._name, "run_before_pass") + + def run_after_pass(self, mod, pass_info): + print(self._name, "run_after_pass") + + +@pass_instrument +class PassFine(PassExampleBase): + pass + + +@pass_instrument +class PassBadEnterCtx(PassExampleBase): + def enter_pass_ctx(self): + print(self._name, "bad enter_pass_ctx!!!") + raise ValueError("{} bad enter_pass_ctx".format(self._name)) + + +@pass_instrument +class PassBadExitCtx(PassExampleBase): + def exit_pass_ctx(self): + print(self._name, "bad exit_pass_ctx!!!") + raise ValueError("{} bad exit_pass_ctx".format(self._name)) + + +############################################################################### +# If an exception occur in ``enter_pass_ctx``, ``PassContext`` disable the pass +# instrumentation. And it will run ``exit_pass_ctx`` of each ``PassInstrument`` +# which successfully finished ``enter_pass_ctx``. +# +# In following example, we can see ``exit_pass_ctx`` of `PassFine_0` is executed after exception. +demo_ctx = tvm.transform.PassContext( + instruments=[ + PassFine("PassFine_0"), + PassBadEnterCtx("PassBadEnterCtx"), + PassFine("PassFine_1"), + ] +) +try: + with demo_ctx: + relay_mod = relay.transform.InferType()(relay_mod) +except ValueError as ex: + print("Catching", str(ex).split("\n")[-1]) + +############################################################################### +# Also, all ``PassInstrument`` are cleared. +# So nothing printed while ``override_instruments`` is called. +demo_ctx.override_instruments([]) # no PassFine_0 exit_pass_ctx printed....etc + +############################################################################### +# If an exception occur in ``exit_pass_ctx``, pass instrumentation is disabled. +# Then exception is thrown. That means ``PassInstrument`` registered Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. +# +# Note that ``exit_pass_ctx`` of ``PassTimingInstrument`` is called. +# Profiles are cleared so nothing is printed. +cur_pass_ctx.override_instruments([]) +# Uncomment the call to .render() to see a warning like: +# Warning: no passes have been profiled, did you enable pass profiling? +# profiles = timing_inst.render() + + +############################################################################### +# Create Customized Instrument Class +# ---------------------------------- +# A customized instrument class can be easily created by +# :py:func:`tvm.instrument.pass_instrument` decorator. +# +# Let's create an instrument class which calculate the difference of ``CallNode`` +# counting per ``op.name`` before and after passes. + +# decorate the class +@pass_instrument +class RelayCallNodeDiffer: + def __init__(self): + self._op_diff = [] + # Passes can be nested. + # Use stack to make sure we get correct before/after pairs. + self._op_cnt_before_stack = [] + + def enter_pass_ctx(self): + self._op_diff = [] + self._op_cnt_before_stack = [] + + def exit_pass_ctx(self): + assert len(self._op_cnt_before_stack) == 0, "The stack is not empty. Something wrong." + + def run_before_pass(self, mod, info): + self._op_cnt_before_stack.append((info.name, self._count_nodes(mod))) + + def run_after_pass(self, mod, info): + # Pop out the latest recorded pass. + name_before, op_to_cnt_before = self._op_cnt_before_stack.pop() + assert name_before == info.name, "name_before: {}, info.name: {} doesn't match".format( + name_before, info.name + ) + cur_depth = len(self._op_cnt_before_stack) + op_to_cnt_after = self._count_nodes(mod) + op_diff = self._diff(op_to_cnt_after, op_to_cnt_before) + # only record passes causing differences. + if op_diff: + self._op_diff.append((cur_depth, info.name, op_diff)) + + def get_pass_to_op_diff(self): + """ + return [ + (depth, pass_name, {op_name: diff_num, ...}), ... + ] + """ + return self._op_diff + + @staticmethod + def _count_nodes(mod): + ret = {} + + def visit(node): + if isinstance(node, relay.expr.Call): + try: + op_name = node.op.name + except AttributeError: + # Some CallNode may not have 'name' such as relay.Function + return + try: + ret[op_name] += 1 + except KeyError: + ret[op_name] = 1 + + relay.analysis.post_order_visit(mod["main"], visit) + return ret + + @staticmethod + def _diff(d_after, d_before): + # d_after - d_before + ret = {} + key_after, key_before = set(d_after), set(d_before) + for k in key_before & key_after: + tmp = d_after[k] - d_before[k] + if tmp: + ret[k] = d_after[k] - d_before[k] + for k in key_after - key_before: + ret[k] = d_after[k] + for k in key_before - key_after: + ret[k] = -d_before[k] + return ret + + +############################################################################### +# Apply Passes and Multiple Instrument Classes +# -------------------------------------------- +# Apply any pass you wish. Here :py:class:`tvm.relay.transform.ConvertLayout` +# and :py:class:`tvm.relay.transform.FoldConstant` are used. +# +# ``ConvertLayout`` might add ``layout_transform`` Op while ``FoldConstant`` can +# reduce the number of ``CallNode``. +# +# We can also use multiple instrument classes in a ``PassContext``. +# However, it should be noted that instrument methods are executed sequentially, +# obeying the order of ``instruments`` argument. +# So for instrument classes like ``PassTimingInstrument``, it is inevitable to +# count-up the execution time of other instrument classes to the final +# profile result. +call_node_inst = RelayCallNodeDiffer() +desired_layouts = { + "nn.conv2d": ["NHWC", "HWIO"], +} +# Because layout_transform may be added as a successor of Constant, +# we run FoldConstant twice. +# Though it is obvious only the FoldConstant after the ConvertLayout matter, +# we want to show how many layout_transform is added as a successor of +# Constant. +pass_seq = tvm.transform.Sequential( + [ + relay.transform.FoldConstant(), + relay.transform.ConvertLayout(desired_layouts), + relay.transform.FoldConstant(), + ] +) +# bind parameters to make VarNode as ConstantNode. +relay_mod["main"] = bind_params_by_name(relay_mod["main"], relay_params) +# timing_inst is put after call_node_inst. +# So the execution time of ``call_node.inst.run_after_pass()`` is also counted. +with tvm.transform.PassContext(opt_level=3, instruments=[call_node_inst, timing_inst]): + relay_mod = pass_seq(relay_mod) + profiles = timing_inst.render() +# Uncomment the next line to see timing-profile results. +# print(profiles) + + +############################################################################### +# We can see how many CallNode increase/decrease per op type. +from pprint import pprint + +pprint(call_node_inst.get_pass_to_op_diff()) + + +############################################################################### +# Exception Handling +# ------------------ +# Let's see what happen if exceptions occur in each methods of a ``PassInstrument``. +# +# Define ``PassInstrument`` classes which raise exceptions in enter/exit ``PassContext``: +class PassExampleBase: + def __init__(self, name): + self._name = name + + def enter_pass_ctx(self): + print(self._name, "enter_pass_ctx") + + def exit_pass_ctx(self): + print(self._name, "exit_pass_ctx") + + def should_run(self, mod, info): + print(self._name, "should_run") + return True + + def run_before_pass(self, mod, pass_info): + print(self._name, "run_before_pass") + + def run_after_pass(self, mod, pass_info): + print(self._name, "run_after_pass") + + +@pass_instrument +class PassFine(PassExampleBase): + pass + + +@pass_instrument +class PassBadEnterCtx(PassExampleBase): + def enter_pass_ctx(self): + print(self._name, "bad enter_pass_ctx!!!") + raise ValueError("{} bad enter_pass_ctx".format(self._name)) + + +@pass_instrument +class PassBadExitCtx(PassExampleBase): + def exit_pass_ctx(self): + print(self._name, "bad exit_pass_ctx!!!") + raise ValueError("{} bad exit_pass_ctx".format(self._name)) + + +############################################################################### +# If an exception occur in ``enter_pass_ctx``, ``PassContext`` disable the pass +# instrumentation. And it will run ``exit_pass_ctx`` of each ``PassInstrument`` +# which successfully finished ``enter_pass_ctx``. +# +# In following example, we can see ``exit_pass_ctx`` of `PassFine_0` is executed after exception. +demo_ctx = tvm.transform.PassContext( + instruments=[ + PassFine("PassFine_0"), + PassBadEnterCtx("PassBadEnterCtx"), + PassFine("PassFine_1"), + ] +) +try: + with demo_ctx: + relay_mod = relay.transform.InferType()(relay_mod) +except ValueError as ex: + print("Catching", str(ex).split("\n")[-1]) + +############################################################################### +# Also, all ``PassInstrument`` are cleared. +# So nothing printed while ``override_instruments`` is called. +demo_ctx.override_instruments([]) # no PassFine_0 exit_pass_ctx printed....etc + +############################################################################### +# If an exception occur in ``exit_pass_ctx``, pass instrumentation is disabled. Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. +# +# Note that ``exit_pass_ctx`` of ``PassTimingInstrument`` is called. +# Profiles are cleared so nothing is printed. +cur_pass_ctx.override_instruments([]) +# Uncomment the call to .render() to see a warning like: +# Warning: no passes have been profiled, did you enable pass profiling? +# profiles = timing_inst.render() + + +############################################################################### +# Create Customized Instrument Class +# ---------------------------------- +# A customized instrument class can be easily created by +# :py:func:`tvm.instrument.pass_instrument` decorator. +# +# Let's create an instrument class which calculate the difference of ``CallNode`` +# counting per ``op.name`` before and after passes. + +# decorate the class +@pass_instrument +class RelayCallNodeDiffer: + def __init__(self): + self._op_diff = [] + # Passes can be nested. + # Use stack to make sure we get correct before/after pairs. + self._op_cnt_before_stack = [] + + def enter_pass_ctx(self): + self._op_diff = [] + self._op_cnt_before_stack = [] + + def exit_pass_ctx(self): + assert len(self._op_cnt_before_stack) == 0, "The stack is not empty. Something wrong." + + def run_before_pass(self, mod, info): + self._op_cnt_before_stack.append((info.name, self._count_nodes(mod))) + + def run_after_pass(self, mod, info): + # Pop out the latest recorded pass. + name_before, op_to_cnt_before = self._op_cnt_before_stack.pop() + assert name_before == info.name, "name_before: {}, info.name: {} doesn't match".format( + name_before, info.name + ) + cur_depth = len(self._op_cnt_before_stack) + op_to_cnt_after = self._count_nodes(mod) + op_diff = self._diff(op_to_cnt_after, op_to_cnt_before) + # only record passes causing differences. + if op_diff: + self._op_diff.append((cur_depth, info.name, op_diff)) + + def get_pass_to_op_diff(self): + """ + return [ + (depth, pass_name, {op_name: diff_num, ...}), ... + ] + """ + return self._op_diff + + @staticmethod + def _count_nodes(mod): + ret = {} + + def visit(node): + if isinstance(node, relay.expr.Call): + try: + op_name = node.op.name + except AttributeError: + # Some CallNode may not have 'name' such as relay.Function + return + try: + ret[op_name] += 1 + except KeyError: + ret[op_name] = 1 + + relay.analysis.post_order_visit(mod["main"], visit) + return ret + + @staticmethod + def _diff(d_after, d_before): + # d_after - d_before + ret = {} + key_after, key_before = set(d_after), set(d_before) + for k in key_before & key_after: + tmp = d_after[k] - d_before[k] + if tmp: + ret[k] = d_after[k] - d_before[k] + for k in key_after - key_before: + ret[k] = d_after[k] + for k in key_before - key_after: + ret[k] = -d_before[k] + return ret + + +############################################################################### +# Apply Passes and Multiple Instrument Classes +# -------------------------------------------- +# Apply any pass you wish. Here :py:class:`tvm.relay.transform.ConvertLayout` +# and :py:class:`tvm.relay.transform.FoldConstant` are used. +# +# ``ConvertLayout`` might add ``layout_transform`` Op while ``FoldConstant`` can +# reduce the number of ``CallNode``. +# +# We can also use multiple instrument classes in a ``PassContext``. +# However, it should be noted that instrument methods are executed sequentially, +# obeying the order of ``instruments`` argument. +# So for instrument classes like ``PassTimingInstrument``, it is inevitable to +# count-up the execution time of other instrument classes to the final +# profile result. +call_node_inst = RelayCallNodeDiffer() +desired_layouts = { + "nn.conv2d": ["NHWC", "HWIO"], +} +# Because layout_transform may be added as a successor of Constant, +# we run FoldConstant twice. +# Though it is obvious only the FoldConstant after the ConvertLayout matter, +# we want to show how many layout_transform is added as a successor of +# Constant. +pass_seq = tvm.transform.Sequential( + [ + relay.transform.FoldConstant(), + relay.transform.ConvertLayout(desired_layouts), + relay.transform.FoldConstant(), + ] +) +# bind parameters to make VarNode as ConstantNode. +relay_mod["main"] = bind_params_by_name(relay_mod["main"], relay_params) +# timing_inst is put after call_node_inst. +# So the execution time of ``call_node.inst.run_after_pass()`` is also counted. +with tvm.transform.PassContext(opt_level=3, instruments=[call_node_inst, timing_inst]): + relay_mod = pass_seq(relay_mod) + profiles = timing_inst.render() +# Uncomment the next line to see timing-profile results. +# print(profiles) + + +############################################################################### +# We can see how many CallNode increase/decrease per op type. +from pprint import pprint + +pprint(call_node_inst.get_pass_to_op_diff()) + + +############################################################################### +# Exception Handling +# ------------------ +# Let's see what happen if exceptions occur in each methods of a ``PassInstrument``. +# +# Define ``PassInstrument`` classes which raise exceptions in enter/exit ``PassContext``: +class PassExampleBase: + def __init__(self, name): + self._name = name + + def enter_pass_ctx(self): + print(self._name, "enter_pass_ctx") + + def exit_pass_ctx(self): + print(self._name, "exit_pass_ctx") + + def should_run(self, mod, info): + print(self._name, "should_run") + return True + + def run_before_pass(self, mod, pass_info): + print(self._name, "run_before_pass") + + def run_after_pass(self, mod, pass_info): + print(self._name, "run_after_pass") + + +@pass_instrument +class PassFine(PassExampleBase): + pass + + +@pass_instrument +class PassBadEnterCtx(PassExampleBase): + def enter_pass_ctx(self): + print(self._name, "bad enter_pass_ctx!!!") + raise ValueError("{} bad enter_pass_ctx".format(self._name)) + + +@pass_instrument +class PassBadExitCtx(PassExampleBase): + def exit_pass_ctx(self): + print(self._name, "bad exit_pass_ctx!!!") + raise ValueError("{} bad exit_pass_ctx".format(self._name)) + + +############################################################################### +# If an exception occur in ``enter_pass_ctx``, ``PassContext`` disable the pass +# instrumentation. And it will run ``exit_pass_ctx`` of each ``PassInstrument`` +# which successfully finished ``enter_pass_ctx``. +# +# In following example, we can see ``exit_pass_ctx`` of `PassFine_0` is executed after exception. +demo_ctx = tvm.transform.PassContext( + instruments=[ + PassFine("PassFine_0"), + PassBadEnterCtx("PassBadEnterCtx"), + PassFine("PassFine_1"), + ] +) +try: + with demo_ctx: + relay_mod = relay.transform.InferType()(relay_mod) +except ValueError as ex: + print("Catching", str(ex).split("\n")[-1]) + +############################################################################### +# Also, all ``PassInstrument`` are cleared. +# So nothing printed while ``override_instruments`` is called. Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. +# +# Note that ``exit_pass_ctx`` of ``PassTimingInstrument`` is called. +# Profiles are cleared so nothing is printed. +cur_pass_ctx.override_instruments([]) +# Uncomment the call to .render() to see a warning like: +# Warning: no passes have been profiled, did you enable pass profiling? +# profiles = timing_inst.render() + + +############################################################################### +# Create Customized Instrument Class +# ---------------------------------- +# A customized instrument class can be easily created by +# :py:func:`tvm.instrument.pass_instrument` decorator. +# +# Let's create an instrument class which calculate the difference of ``CallNode`` +# counting per ``op.name`` before and after passes. + +# decorate the class +@pass_instrument +class RelayCallNodeDiffer: + def __init__(self): + self._op_diff = [] + # Passes can be nested. + # Use stack to make sure we get correct before/after pairs. + self._op_cnt_before_stack = [] + + def enter_pass_ctx(self): + self._op_diff = [] + self._op_cnt_before_stack = [] + + def exit_pass_ctx(self): + assert len(self._op_cnt_before_stack) == 0, "The stack is not empty. Something wrong." + + def run_before_pass(self, mod, info): + self._op_cnt_before_stack.append((info.name, self._count_nodes(mod))) + + def run_after_pass(self, mod, info): + # Pop out the latest recorded pass. + name_before, op_to_cnt_before = self._op_cnt_before_stack.pop() + assert name_before == info.name, "name_before: {}, info.name: {} doesn't match".format( + name_before, info.name + ) + cur_depth = len(self._op_cnt_before_stack) + op_to_cnt_after = self._count_nodes(mod) + op_diff = self._diff(op_to_cnt_after, op_to_cnt_before) + # only record passes causing differences. + if op_diff: + self._op_diff.append((cur_depth, info.name, op_diff)) + + def get_pass_to_op_diff(self): + """ + return [ + (depth, pass_name, {op_name: diff_num, ...}), ... + ] + """ + return self._op_diff + + @staticmethod + def _count_nodes(mod): + ret = {} + + def visit(node): + if isinstance(node, relay.expr.Call): + try: + op_name = node.op.name + except AttributeError: + # Some CallNode may not have 'name' such as relay.Function + return + try: + ret[op_name] += 1 + except KeyError: + ret[op_name] = 1 + + relay.analysis.post_order_visit(mod["main"], visit) + return ret + + @staticmethod + def _diff(d_after, d_before): + # d_after - d_before + ret = {} + key_after, key_before = set(d_after), set(d_before) + for k in key_before & key_after: + tmp = d_after[k] - d_before[k] + if tmp: + ret[k] = d_after[k] - d_before[k] + for k in key_after - key_before: + ret[k] = d_after[k] + for k in key_before - key_after: + ret[k] = -d_before[k] + return ret + + +############################################################################### +# Apply Passes and Multiple Instrument Classes +# -------------------------------------------- +# Apply any pass you wish. Here :py:class:`tvm.relay.transform.ConvertLayout` +# and :py:class:`tvm.relay.transform.FoldConstant` are used. +# +# ``ConvertLayout`` might add ``layout_transform`` Op while ``FoldConstant`` can +# reduce the number of ``CallNode``. +# +# We can also use multiple instrument classes in a ``PassContext``. +# However, it should be noted that instrument methods are executed sequentially, +# obeying the order of ``instruments`` argument. +# So for instrument classes like ``PassTimingInstrument``, it is inevitable to +# count-up the execution time of other instrument classes to the final +# profile result. +call_node_inst = RelayCallNodeDiffer() +desired_layouts = { + "nn.conv2d": ["NHWC", "HWIO"], +} +# Because layout_transform may be added as a successor of Constant, +# we run FoldConstant twice. +# Though it is obvious only the FoldConstant after the ConvertLayout matter, +# we want to show how many layout_transform is added as a successor of +# Constant. +pass_seq = tvm.transform.Sequential( + [ + relay.transform.FoldConstant(), + relay.transform.ConvertLayout(desired_layouts), + relay.transform.FoldConstant(), + ] +) +# bind parameters to make VarNode as ConstantNode. +relay_mod["main"] = bind_params_by_name(relay_mod["main"], relay_params) +# timing_inst is put after call_node_inst. +# So the execution time of ``call_node.inst.run_after_pass()`` is also counted. +with tvm.transform.PassContext(opt_level=3, instruments=[call_node_inst, timing_inst]): + relay_mod = pass_seq(relay_mod) + profiles = timing_inst.render() +# Uncomment the next line to see timing-profile results. +# print(profiles) + + +############################################################################### +# We can see how many CallNode increase/decrease per op type. +from pprint import pprint + +pprint(call_node_inst.get_pass_to_op_diff()) + + +############################################################################### +# Exception Handling +# ------------------ +# Let's see what happen if exceptions occur in each methods of a ``PassInstrument``. +# +# Define ``PassInstrument`` classes which raise exceptions in enter/exit ``PassContext``: +class PassExampleBase: + def __init__(self, name): + self._name = name + + def enter_pass_ctx(self): + print(self._name, "enter_pass_ctx") + + def exit_pass_ctx(self): + print(self._name, "exit_pass_ctx") + + def should_run(self, mod, info): + print(self._name, "should_run") + return True + + def run_before_pass(self, mod, pass_info): + print(self._name, "run_before_pass") + + def run_after_pass(self, mod, pass_info): + print(self._name, "run_after_pass") + + +@pass_instrument +class PassFine(PassExampleBase): + pass + + +@pass_instrument +class PassBadEnterCtx(PassExampleBase): + def enter_pass_ctx(self): + print(self._name, "bad enter_pass_ctx!!!") + raise ValueError("{} bad enter_pass_ctx".format(self._name)) + + +@pass_instrument +class PassBadExitCtx(PassExampleBase): + def exit_pass_ctx(self): + print(self._name, "bad exit_pass_ctx!!!") + raise ValueError("{} bad exit_pass_ctx".format(self._name)) + + +############################################################################### +# If an exception occur in ``enter_pass_ctx``, ``PassContext`` disable the pass +# instrumentation. And it will run ``exit_pass_ctx`` of each ``PassInstrument`` Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. +# +# Note that ``exit_pass_ctx`` of ``PassTimingInstrument`` is called. +# Profiles are cleared so nothing is printed. +cur_pass_ctx.override_instruments([]) +# Uncomment the call to .render() to see a warning like: +# Warning: no passes have been profiled, did you enable pass profiling? +# profiles = timing_inst.render() + + +############################################################################### +# Create Customized Instrument Class +# ---------------------------------- +# A customized instrument class can be easily created by Review comment: Done. ########## File path: tutorials/dev/use_pass_instrument.py ########## @@ -0,0 +1,378 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# pylint: disable=line-too-long +""" +.. _tutorial-use-pass-instrument: + +How to Use TVM Pass Instrument +============================== +**Author**: `Chi-Wei Wang <https://github.com/chiwwang>`_ + +As more and more passes are implemented, it becomes useful to instrument +passes execution, analyze per-pass effects and observe various events. +Pass infrastructure provides instrument mechanism. One can pass a list of +instrument instances to :py:class:`tvm.transform.PassContext`. +Also a decorator :py:func:`tvm.instrument.pass_instrument` is provided +to easily implement instrument classes. + +This tutorial demostrates how developers can use ``PassContext`` to instrument +passes. Please also refer to the :ref:`pass-infra`. +""" +import tvm +import tvm.relay as relay +from tvm.relay.testing import resnet +from tvm.contrib.download import download_testdata +from tvm.relay.build_module import bind_params_by_name +from tvm.ir.instrument import ( + PassTimingInstrument, + pass_instrument, +) + + +############################################################################### +# Create An Example Relay Program +# ------------------------------- +# We use pre-defined resnet-18 network in Relay. +batch_size = 1 +num_of_image_class = 1000 +image_shape = (3, 224, 224) +output_shape = (batch_size, num_of_image_class) +relay_mod, relay_params = resnet.get_workload(num_layers=18, batch_size=1, image_shape=image_shape) +print(relay_mod.astext(show_meta_data=False)) + + +############################################################################### +# Create PassContext With Instruments +# ----------------------------------- +# It is as simple as passing ``instruments`` argument to ``PassContext`` constructor. +# A built-in ``PassTimingInstrument`` is used to profile the execution time of +# each passes. +timing_inst = PassTimingInstrument() +with tvm.transform.PassContext(instruments=[timing_inst]): + relay_mod = relay.transform.InferType()(relay_mod) + relay_mod = relay.transform.FoldScaleAxis()(relay_mod) + # before exiting the context, get profile results. + profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Use Current PassContext With Instruments +# ---------------------------------------- +# One can also use the current ``PassContext`` and register +# ``PassInstrument`` instances by ``override_instruments`` method. +# Note that ``override_instruments`` executes ``exit_pass_ctx`` method +# if any instrument already exists. Then it switches to new instruments +# and calls ``enter_pass_ctx`` method of new instruments. +# Refer to following sections and :py:func:`tvm.instrument.pass_instrument` for these methods. +cur_pass_ctx = tvm.transform.PassContext.current() +cur_pass_ctx.override_instruments([timing_inst]) +relay_mod = relay.transform.InferType()(relay_mod) +relay_mod = relay.transform.FoldScaleAxis()(relay_mod) +profiles = timing_inst.render() +print(profiles) + + +############################################################################### +# Register empty list to clear instruments. +# +# Note that ``exit_pass_ctx`` of ``PassTimingInstrument`` is called. +# Profiles are cleared so nothing is printed. +cur_pass_ctx.override_instruments([]) +# Uncomment the call to .render() to see a warning like: +# Warning: no passes have been profiled, did you enable pass profiling? +# profiles = timing_inst.render() + + +############################################################################### +# Create Customized Instrument Class +# ---------------------------------- +# A customized instrument class can be easily created by +# :py:func:`tvm.instrument.pass_instrument` decorator. +# +# Let's create an instrument class which calculate the difference of ``CallNode`` +# counting per ``op.name`` before and after passes. Review comment: Done. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@tvm.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
