comaniac commented on a change in pull request #9382: URL: https://github.com/apache/tvm/pull/9382#discussion_r738727953
########## 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( Review comment: Now I understand the difference between `query` and `entry_point`. Maybe renaming them as follows? `query` -> `query`: Query with the self context. `entry_point` -> `query_with_env`: Query with the current context. ########## File path: tests/python/unittest/test_meta_schedule_integration.py ########## @@ -0,0 +1,111 @@ +# 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. +import sys + +import pytest +import tvm +from tvm import meta_schedule as ms +from tvm.meta_schedule.integration import IntegrationContext, TaskExtraction +from tvm.meta_schedule.testing import get_network + +from tvm.script import tir as T + +# pylint: disable=invalid-name,no-member,line-too-long,too-many-nested-blocks,missing-docstring,unbalanced-tuple-unpacking + + [email protected]_module +class MockModule: + @T.prim_func + def main(a: T.handle, b: T.handle) -> None: # pylint: disable=no-self-argument + T.func_attr({"global_symbol": "main", "tir.noalias": True}) + A = T.match_buffer(a, (16,), "float32") + B = T.match_buffer(b, (16,), "float32") + for i in T.serial(0, 16): + with T.block("matmul"): + vi = T.axis.remap("S", [i]) + B[vi] = A[vi] + + +# pylint: enable=invalid-name,no-member,line-too-long,too-many-nested-blocks,missing-docstring,unbalanced-tuple-unpacking + + +def test_meta_schedule_integration_task_extraction_query(): + mod, _, _, _ = get_network( + name="resnet-18", + batch_size=1, + layout="NHWC", + dtype="float32", + ) + env = TaskExtraction() + env.query(task_name="mock-task", mod=mod, dispatched=[MockModule]) + (task,) = env.tasks + assert task.task_name == "mock-task" + tvm.ir.assert_structural_equal(task.mod, mod) + (tir_mod,) = task.dispatched + tvm.ir.assert_structural_equal(tir_mod, MockModule) + + +def test_meta_schedule_integration_current(): + env = TaskExtraction() + with env: + assert IntegrationContext.current() == env + + +def test_meta_schedule_integration_no_current(): + assert IntegrationContext.current() is None + + +def test_meta_schedule_integration_multiple_current(): + env = TaskExtraction() + with env: + with pytest.raises(ValueError): + with env: + ... + + +def test_meta_schedule_integration_entry_point(): + mod, _, _, _ = get_network( + name="resnet-18", + batch_size=1, + layout="NHWC", + dtype="float32", + ) + env = TaskExtraction() + env.query(task_name="mock-task", mod=mod, dispatched=[MockModule]) + with env: + IntegrationContext.entry_point(task_name="mock-task", mod=mod, dispatched=[MockModule]) Review comment: Per offline discussion, refactoring this test could resolve my confusions. ########## 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 Review comment: I think TE compiler calls `EntryPoint`, not query? -- 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]
