search_strategy.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_SEARCH_STRATEGY_H_
#define TVM_META_SCHEDULE_SEARCH_STRATEGY_H_

#include <tvm/meta_schedule/arg_info.h>
#include <tvm/meta_schedule/runner.h>
#include <tvm/tir/schedule/schedule.h>

namespace tvm {
namespace meta_schedule {

// Forward declaration
class TuneContext;

class MeasureCandidateNode : public runtime::Object {
 public:
  tir::Schedule sch;
  Array<ArgInfo> args_info;

  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("sch", &sch);
    v->Visit("args_info", &args_info);
  }

  static constexpr const char* _type_key = "meta_schedule.MeasureCandidate";
  TVM_DECLARE_FINAL_OBJECT_INFO(MeasureCandidateNode, Object);
};

class MeasureCandidate : public runtime::ObjectRef {
 public:
  TVM_DLL MeasureCandidate(tir::Schedule sch, Array<ArgInfo> args_info);
  TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS(MeasureCandidate, ObjectRef, MeasureCandidateNode);
};

class SearchStrategyNode : public runtime::Object {
 public:
  virtual ~SearchStrategyNode() = default;

  virtual void InitializeWithTuneContext(const TuneContext& tune_context) = 0;

  virtual void PreTuning(const Array<tir::Schedule>& design_spaces) = 0;

  virtual void PostTuning() = 0;

  virtual Optional<Array<MeasureCandidate>> GenerateMeasureCandidates() = 0;

  virtual void NotifyRunnerResults(const Array<RunnerResult>& results) = 0;

  static constexpr const char* _type_key = "meta_schedule.SearchStrategy";
  TVM_DECLARE_BASE_OBJECT_INFO(SearchStrategyNode, Object);
};

class PySearchStrategyNode : public SearchStrategyNode {
 public:
  using FInitializeWithTuneContext = runtime::TypedPackedFunc<void(const TuneContext&)>;
  using FPreTuning = runtime::TypedPackedFunc<void(const Array<tir::Schedule>&)>;
  using FPostTuning = runtime::TypedPackedFunc<void()>;
  using FGenerateMeasureCandidates = runtime::TypedPackedFunc<Optional<Array<MeasureCandidate>>()>;
  using FNotifyRunnerResults = runtime::TypedPackedFunc<void(const Array<RunnerResult>&)>;

  FInitializeWithTuneContext f_initialize_with_tune_context;
  FPreTuning f_pre_tuning;
  FPostTuning f_post_tuning;
  FGenerateMeasureCandidates f_generate_measure_candidates;
  FNotifyRunnerResults f_notify_runner_results;

  void VisitAttrs(tvm::AttrVisitor* v) {
    // `f_initialize_with_tune_context` is not visited
    // `f_pre_tuning` is not visited
    // `f_post_tuning` is not visited
    // `f_generate_measure_candidates` is not visited
    // `f_notify_runner_results` is not visited
  }

  void InitializeWithTuneContext(const TuneContext& context) final {
    ICHECK(f_initialize_with_tune_context != nullptr)
        << "PySearchStrategy's InitializeWithTuneContext method not implemented!";
    this->f_initialize_with_tune_context(context);
  }

  void PreTuning(const Array<tir::Schedule>& design_spaces) final {
    ICHECK(f_pre_tuning != nullptr) << "PySearchStrategy's PreTuning method not implemented!";
    this->f_pre_tuning(design_spaces);
  }

  void PostTuning() final {
    ICHECK(f_post_tuning != nullptr) << "PySearchStrategy's PostTuning method not implemented!";
    this->f_post_tuning();
  }

  Optional<Array<MeasureCandidate>> GenerateMeasureCandidates() final {
    ICHECK(f_generate_measure_candidates != nullptr)
        << "PySearchStrategy's GenerateMeasureCandidates method not implemented!";
    return this->f_generate_measure_candidates();
  }

  void NotifyRunnerResults(const Array<RunnerResult>& results) final {
    ICHECK(f_notify_runner_results != nullptr)
        << "PySearchStrategy's NotifyRunnerResults method not implemented!";
    this->f_notify_runner_results(results);
  }

  static constexpr const char* _type_key = "meta_schedule.PySearchStrategy";
  TVM_DECLARE_FINAL_OBJECT_INFO(PySearchStrategyNode, SearchStrategyNode);
};

class SearchStrategy : public runtime::ObjectRef {
 public:
  TVM_DLL static SearchStrategy PySearchStrategy(
      PySearchStrategyNode::FInitializeWithTuneContext f_initialize_with_tune_context,  //
      PySearchStrategyNode::FPreTuning f_pre_tuning,                                    //
      PySearchStrategyNode::FPostTuning f_post_tuning,                                  //
      PySearchStrategyNode::FGenerateMeasureCandidates f_generate_measure_candidates,   //
      PySearchStrategyNode::FNotifyRunnerResults f_notify_runner_results);

  TVM_DLL static SearchStrategy ReplayTrace(int num_trials_per_iter, int num_trials_total);

  TVM_DEFINE_MUTABLE_OBJECT_REF_METHODS(SearchStrategy, ObjectRef, SearchStrategyNode);
};

}  // namespace meta_schedule
}  // namespace tvm

#endif  // TVM_META_SCHEDULE_SEARCH_STRATEGY_H_