chiwwang commented on a change in pull request #8220: URL: https://github.com/apache/tvm/pull/8220#discussion_r660231889
########## 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 Review comment: Removed. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
