apply_history_best.h

Go to the documentation of this file.

/*
 * 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.
 */
#ifndef TVM_META_SCHEDULE_APPLY_HISTORY_BEST_H_
#define TVM_META_SCHEDULE_APPLY_HISTORY_BEST_H_

#include <tvm/ir/module.h>
#include <tvm/meta_schedule/database.h>
#include <tvm/node/reflection.h>
#include <tvm/runtime/container/array.h>
#include <tvm/runtime/container/optional.h>
#include <tvm/runtime/container/string.h>
#include <tvm/runtime/object.h>
#include <tvm/runtime/packed_func.h>
#include <tvm/target/target.h>
#include <tvm/te/tensor.h>

namespace tvm {
namespace meta_schedule {

class ApplyHistoryBestNode : public runtime::Object {
 public:
  using FTEFilterFunc =
      runtime::TypedPackedFunc<Optional<tir::PrimFunc>(const Array<te::Tensor, void>&)>;
  using FTakeTuningRecord = runtime::TypedPackedFunc<void(const TuningRecord&)>;

  Database database{nullptr};
  FTEFilterFunc te_filter_func{nullptr};
  PackedFunc logging_func;

  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("database", &database);
    // `te_filter_func` is not visited
    // `logging_func` is not visited
  }
  Optional<IRModule> Query(runtime::String task_name, IRModule mod, Target target,
                           Optional<Array<IRModule>> dispatched,
                           FTakeTuningRecord f_take_tuning_record);

  static constexpr const char* _type_key = "meta_schedule.ApplyHistoryBest";
  TVM_DECLARE_FINAL_OBJECT_INFO(ApplyHistoryBestNode, runtime::Object);
};

class ApplyHistoryBest : public runtime::ObjectRef {
 public:
  explicit ApplyHistoryBest(Database database, ApplyHistoryBestNode::FTEFilterFunc te_filter_func,
                            PackedFunc logging_func);
  static Optional<ApplyHistoryBest> Current();

  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(ApplyHistoryBest, runtime::ObjectRef,
                                                    ApplyHistoryBestNode);

 protected:
  friend class ApplyHistoryBestInternal;
  void EnterWithScope();
  void ExitWithScope();
};

}  // namespace meta_schedule
}  // namespace tvm

#endif  // TVM_META_SCHEDULE_APPLY_HISTORY_BEST_H_