junrushao1994 commented on a change in pull request #9382: URL: https://github.com/apache/tvm/pull/9382#discussion_r738657637
########## File path: python/tvm/meta_schedule/integration.py ########## @@ -0,0 +1,236 @@ +# 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. +"""Meta schedule integration with high-level IR""" +from contextlib import contextmanager +from typing import Callable, Dict, List, Optional, Union + +from tvm._ffi import register_object +from tvm.ir import IRModule, transform +from tvm.relay import Function as RelayFunc, vm +from tvm.runtime import NDArray, Object +from tvm.target import Target +from tvm.tir import PrimFunc + +from . import _ffi_api + + +@register_object("meta_schedule.ExtractedTask") +class ExtractedTask(Object): + """A tuning task extracted from the high-level IR + + Parameters + ---------- + task_name : str + The name of the task extracted + mod : IRModule + The high-level IR + dispatched : List[IRModule] + A list of low-level IRs that the high-level IR could potentially dispatch to + """ + + task_name: str + mod: IRModule + dispatched: List[IRModule] + + def __init__( + self, + task_name: str, + mod: IRModule, + dispatched: List[IRModule], + ) -> None: + self.__init_handle_by_constructor__( + _ffi_api.ExtractedTask, # type: ignore # pylint: disable=no-member + task_name, + mod, + dispatched, + ) + + +@register_object("meta_schedule.IntegrationContext") +class IntegrationContext(Object): + """A context manager interface for the integration""" + + def query( + self, + task_name: str, + mod: IRModule, + dispatched: Optional[List[IRModule]], + ) -> Union[IRModule, RelayFunc, PrimFunc, None]: + """The entry point of the integration + + Parameters + ---------- + task_name : str + The name of the task extracted + mod : IRModule + The high-level IR + dispatched : Optional[List[IRModule]] + A list of low-level IRs that the high-level IR could potentially dispatch to + + Returns + ------- + result : Union[IRModule, RelayFunc, PrimFunc, None] + There are different types of the output: + 1) NullOpt if there is no feedback hint; + 2) tir::PrimFunc if `mod` should be lowered to a PrimFunc; + 3) relay::Function if `mod` should be dispatched to BYOC workflow; + 4) IRModule for unified dispatch + """ + return _ffi_api.IntegrationContextQuery( # type: ignore # pylint: disable=no-member + self, + task_name, + mod, + dispatched, + ) + + @staticmethod + def current() -> Optional["IntegrationContext"]: + """The context manager in the current scope + + Returns + ------- + ctx : Optional[IntegrationContext] + The IntegrationContext in the current scope. + NullOpt if it's currently not under any IntegrationContext. + """ + return _ffi_api.IntegrationContextCurrent() # type: ignore # pylint: disable=no-member + + @staticmethod + def entry_point( + task_name: str, + mod: IRModule, + dispatched: Optional[List[IRModule]], + ) -> Union[IRModule, RelayFunc, PrimFunc, None]: + """The entry point of the integration workflow. The compilation process of the high-level + IR should call this method for task extraction and for feedback hints + + Parameters + ---------- + task_name : str + The name of the task + mod : IRModule + The high-level IR + dispatched : Optional[List[IRModule]] + A list of low-level IRs that the high-level IR could potentially dispatch to + + Returns + ------- + result : Union[IRModule, RelayFunc, PrimFunc, None] + There are different types of the output: + 1) NullOpt if there is no feedback hint; + 2) tir::PrimFunc if `mod` should be lowered to a PrimFunc; + 3) relay::Function if `mod` should be dispatched to BYOC workflow; + 4) IRModule for unified dispatch + """ + return _ffi_api.IntegrationContextEntryPoint( # type: ignore # pylint: disable=no-member + task_name, + mod, + dispatched, + ) + + def __enter__(self) -> "IntegrationContext": + """Entering the scope of the context manager""" + _ffi_api.IntegrationContextEnterScope(self) # type: ignore # pylint: disable=no-member + return self + + def __exit__(self, ptype, value, trace) -> None: + """Exiting the scope of the context manager""" + _ffi_api.IntegrationContextExitScope(self) # type: ignore # pylint: disable=no-member + + +@register_object("meta_schedule.TaskExtraction") +class TaskExtraction(IntegrationContext): + """An integration context for task extraction + + Parameters + ---------- + tasks : List[ExtractedTask] + The extracted tasks + """ + + tasks: List[ExtractedTask] + + def __init__(self) -> None: + self.__init_handle_by_constructor__(_ffi_api.TaskExtraction) # type: ignore # pylint: disable=no-member + + +@register_object("meta_schedule.ApplyHistoryBest") +class ApplyHistoryBest(IntegrationContext): + pass + + +def extract_task( + mod: Union[IRModule, RelayFunc], + params: Optional[Dict[str, NDArray]], + target: Target, +) -> List[ExtractedTask]: + """Extract tuning tasks from a relay program. + + Parameters + ---------- + mod : tvm.IRModule or relay.Function + The module or function to tune + params : dict of str to numpy array + The associated parameters of the program + target : Union[tvm.target.Target, str] + The compilation target + + Returns + ------- + tasks: List[ExtractedTask] + The tasks extracted from this network + """ + + @contextmanager + def _autotvm_silencer(): + from tvm import autotvm # pylint: disable=import-outside-toplevel + + silent = autotvm.GLOBAL_SCOPE.silent + autotvm.GLOBAL_SCOPE.silent = True + try: + yield + finally: + autotvm.GLOBAL_SCOPE.silent = silent + + def _thread_run(func: Callable[[], None]) -> None: + import threading # pylint: disable=import-outside-toplevel + + thread = threading.Thread(target=func) + thread.start() + thread.join() + + env = TaskExtraction() + if isinstance(mod, RelayFunc): + mod = IRModule.from_expr(mod) + if not isinstance(target, Target): + target = Target(target) + + def _func(): + with env, _autotvm_silencer(), transform.PassContext( + config={ + "relay.backend.use_meta_schedule": True, + }, + disabled_pass={}, + opt_level=3, Review comment: alternatively, do we allow nesting PassContext and query attributes recursively? -- 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]
