org.apache.spark.rapids.tool.benchmarks.SingleThreadedQualToolBenchmark.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2024, NVIDIA CORPORATION.
 *
 * Licensed 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.
 */

package org.apache.spark.rapids.tool.benchmarks

import com.nvidia.spark.rapids.tool.qualification.QualificationArgs
import com.nvidia.spark.rapids.tool.qualification.QualificationMain.mainInternal

/**
 * This class is used to run the QualificationMain class as a benchmark.
 * This can be used as a reference to write any benchmark class
 * Usage -
 * 1. Override the runBenchmarkSuite method
 * 2. Write the benchmark code in the runBenchmark method passing relevant arguments
 * 3. Define cases and invoke the function to be benchmarked with input arguments
 */
object SingleThreadedQualToolBenchmark extends BenchmarkBase {
  override def runBenchmarkSuite(inputArgs: Array[String]): Unit = {
    // Currently the input arguments are assumed to be common across cases
    // This will be improved in a follow up PR to enable passing as a config
    // file with argument support for different cases
    runBenchmark("Benchmark_Per_SQL_Arg_Qualification") {
      val (prefix, suffix) = inputArgs.splitAt(inputArgs.length - 1)
      addCase("Enable_Per_SQL_Arg_Qualification") { _ =>
        mainInternal(new QualificationArgs(prefix :+ "--per-sql" :+ "--num-threads"
          :+ "1" :+ suffix.head),
          enablePB = true)
      }
      addCase("Disable_Per_SQL_Arg_Qualification") { _ =>
        mainInternal(new QualificationArgs(prefix :+ "--num-threads" :+ "1" :+ suffix.head),
          enablePB = true)
      }
      run()
    }
  }
}