huajsj commented on a change in pull request #8702: URL: https://github.com/apache/tvm/pull/8702#discussion_r707591077
########## File path: python/tvm/contrib/pipeline_executor.py ########## @@ -0,0 +1,525 @@ +# 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. +"""Pipeline executor that executes a series of modules in a pipeline fashion.""" +import json +import tvm._ffi +from tvm import relay +from tvm.relay.transform import InferType +from tvm.contrib import graph_executor + + +def pipeline_executor_enabled(): + """Check if the pipeline executor is enabled. + + Return + ------- + enable: bool + Return whether pipeline executor is enabled. + """ + return tvm._ffi.get_global_func("tvm.pipeline_executor.create", allow_missing=True) is not None + + +def build(pipe_configs): + """Use pipe_config to build and return module list and module dependency configuration. + + Parameters + ---------- + pipe_configs: PipelineConfig + Configuration information for build. + + Returns + ------- + ret: PipelineExecutorFactoryModule + A class that wraps module list and module dependency configuration. + """ + mods = {} + mod_n_configs = pipe_configs.get_config() + config_len = len(mod_n_configs) + string_config = [{} for _ in range(config_len)] + for ir_mod, mod_config in mod_n_configs.items(): + mconf = mod_config["pipeline"].copy() + mod_idx = mconf["mod_idx"] - 1 + # Get mod device configuration. + dev = mod_config["dev"] + target = mod_config["target"] + build_func = relay.build + # Check whether there is a customized build function. + if "build" in mod_config and mod_config["build"]: + build_func = mod_config["build"] + + # Build. + mod = build_func( + ir_mod, + target, + params=mod_config["params"], + target_host=mod_config["target_host"], + mod_name=mod_config["mod_name"], + ) + + mconf["dev"] = "{},{}".format(dev.device_type, dev.device_id) + # Create pipeline configuration. + string_config[mod_idx] = mconf + # Set device. + mods[mod] = {"dev": dev} + + return PipelineExecutorFactoryModule(mods, string_config) + + +def create(pipe_executor_factory_module): + """Create a pipeline runtime executor. + + Parameters + ---------- + pipe_executor_factory_module : PipelineExecutorFactoryModule + It is wrapper class which include IRModule list and pipeline configuration. + + Returns + ------- + submodule : PipelineModule + Runtime pipeline module. + """ + + return PipelineModule(pipe_executor_factory_module) + + +class PipelineModule(object): + """Wrapper of runtime module, caller can use this module to set parameters and get outputs. + + Parameters + ---------- + module : PipelineExecutorFactoryModule + Common interface for pipeline executor factory modules. + """ + + def __init__(self, module): + self.module = module.module + + +class PipelineConfig(object): + """The wrapper of each module to be pipelined. The wrapper mainly includes the + module itself as well as the binding that represents the connections of this + module's inputs and outputs to other modules. + """ + + class Binding: + """This class define the module connection information. + The type can only be either "input" or "output". + + Parameters + ---------- + owner : ModuleWrapper + The class who owns this interface. + + io_type : str + The type of this interface. It can only be either "input" or "output". + + name : str/integer + Name, for input it is string such as "data0", for output it is the + idx integer such as 0. + """ + + def __init__(self, owner, io_type, name, data_type=None): + self.io_owner = owner + self.io_type = io_type + self.name = str(name) + # Child nodes. + self.bindings = [] + # Parents nodes. + self.parents = [] + + self.data_type = data_type + + def get_name(self): + """Return the interface name and name of owner who owns this interface.""" + owner_name = "" + if isinstance(self.io_owner, PipelineConfig.ModuleWrapper): + owner_name = self.io_owner.name + + return owner_name, self.name + + def get_owner_idx(self): + """Return owner idex if owner is ModuleWrapper, if not return 0.""" + if isinstance(self.io_owner, PipelineConfig.ModuleWrapper): + return self.io_owner.idx + + # If not ModuleWrapper then owner is PipelineConfig, return 0 + # to identify this is global interface + return 0 + + def is_global_interface(self): + """The global interface is the interface visible to the caller which use pipeline + executor, the global input interface is responsible for passing parameters to the + internal module interface, and the global output interface is responsible for + outputting the pipeline executor compute results to caller. + """ + return not isinstance(self.io_owner, PipelineConfig.ModuleWrapper) + + def __repr__(self): + """Get all binding(input data) informations that looks like '|data_0: mod1:data_0'.""" + ret = " |{}: ".format(self.name) + for binding in self.bindings: + mname, dname = binding.get_name() + ret += "{0}:{1} ".format(mname, dname) + return ret + + def check_dag_acyclic(self, start, inputs): + """It is to check whether the DAG that contains the inputs interfaces is acyclic.""" Review comment: changed into "This is to check whether the DAG containing these input interfaces is acyclic." here may need to keep 'interfaces' for that there are multiple input interfaces get involved by checking. -- 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]
