Safe Haskell	Safe-Inferred
Language	Haskell2010

Futhark.Bench

Description

Facilities for handling Futhark benchmark results. A Futhark benchmark program is just like a Futhark test program.

Synopsis

newtype RunResult = RunResult {
- runMicroseconds :: Int
}
data DataResult = DataResult Text (Either Text Result)
data BenchResult = BenchResult FilePath [DataResult]
data Result = Result {
- runResults :: [RunResult]
- memoryMap :: Map Text Int
- stdErr :: Maybe Text
}
encodeBenchResults :: [BenchResult] -> ByteString
decodeBenchResults :: ByteString -> Either String [BenchResult]
binaryName :: FilePath -> FilePath
benchmarkDataset :: Server -> RunOptions -> FutharkExe -> FilePath -> Text -> Values -> Maybe Success -> FilePath -> IO (Either Text ([RunResult], Text))
data RunOptions = RunOptions {
- runMinRuns :: Int
- runMinTime :: NominalDiffTime
- runTimeout :: Int
- runVerbose :: Int
- runConvergencePhase :: Bool
- runConvergenceMaxTime :: NominalDiffTime
- runResultAction :: (Int, Maybe Double) -> IO ()
}
prepareBenchmarkProgram :: MonadIO m => Maybe Int -> CompileOptions -> FilePath -> [InputOutputs] -> m (Either (String, Maybe ByteString) ())
data CompileOptions = CompileOptions {
- compFuthark :: String
- compBackend :: String
- compOptions :: [String]
}

Documentation

newtype RunResult Source #

The runtime of a single succesful run.

Constructors

RunResult
Fields runMicroseconds :: Int

Instances

Instances details

FromJSON RunResult Source #
Instance details Defined in Futhark.Bench Methods parseJSON :: Value -> Parser RunResult # parseJSONList :: Value -> Parser [RunResult] #
ToJSON RunResult Source #
Instance details Defined in Futhark.Bench Methods toJSON :: RunResult -> Value # toEncoding :: RunResult -> Encoding # toJSONList :: [RunResult] -> Value # toEncodingList :: [RunResult] -> Encoding #
Show RunResult Source #
Instance details Defined in Futhark.Bench Methods showsPrec :: Int -> RunResult -> ShowS # show :: RunResult -> String # showList :: [RunResult] -> ShowS #
Eq RunResult Source #
Instance details Defined in Futhark.Bench Methods (==) :: RunResult -> RunResult -> Bool # (/=) :: RunResult -> RunResult -> Bool #

data DataResult Source #

The results for a single named dataset is either an error message, or runtime measurements, the number of bytes used, and the stderr that was produced.

Constructors

DataResult Text (Either Text Result)

Instances

Instances details

Show DataResult Source #
Instance details Defined in Futhark.Bench Methods showsPrec :: Int -> DataResult -> ShowS # show :: DataResult -> String # showList :: [DataResult] -> ShowS #
Eq DataResult Source #
Instance details Defined in Futhark.Bench Methods (==) :: DataResult -> DataResult -> Bool # (/=) :: DataResult -> DataResult -> Bool #

data BenchResult Source #

The results for all datasets for some benchmark program.

Constructors

BenchResult FilePath [DataResult]

Instances

Instances details

Show BenchResult Source #
Instance details Defined in Futhark.Bench Methods showsPrec :: Int -> BenchResult -> ShowS # show :: BenchResult -> String # showList :: [BenchResult] -> ShowS #
Eq BenchResult Source #
Instance details Defined in Futhark.Bench Methods (==) :: BenchResult -> BenchResult -> Bool # (/=) :: BenchResult -> BenchResult -> Bool #

data Result Source #

The measurements resulting from various successful runs of a benchmark (same dataset).

Constructors

Result
Fields runResults :: [RunResult] memoryMap :: Map Text Int stdErr :: Maybe Text

Instances

Instances details

FromJSON Result Source #
Instance details Defined in Futhark.Bench Methods parseJSON :: Value -> Parser Result # parseJSONList :: Value -> Parser [Result] #
ToJSON Result Source #
Instance details Defined in Futhark.Bench Methods toJSON :: Result -> Value # toEncoding :: Result -> Encoding # toJSONList :: [Result] -> Value # toEncodingList :: [Result] -> Encoding #
Show Result Source #
Instance details Defined in Futhark.Bench Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
Eq Result Source #
Instance details Defined in Futhark.Bench Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #

encodeBenchResults :: [BenchResult] -> ByteString Source #

Transform benchmark results to a JSON bytestring.

decodeBenchResults :: ByteString -> Either String [BenchResult] Source #

Decode benchmark results from a JSON bytestring.

binaryName :: FilePath -> FilePath Source #

The name we use for compiled programs.

benchmarkDataset :: Server -> RunOptions -> FutharkExe -> FilePath -> Text -> Values -> Maybe Success -> FilePath -> IO (Either Text ([RunResult], Text)) Source #

Run the benchmark program on the indicated dataset.

data RunOptions Source #

How to run a benchmark.

Constructors

RunOptions

Fields

runMinRuns :: Int
Applies both to initial and convergence phase.
runMinTime :: NominalDiffTime
runTimeout :: Int
runVerbose :: Int
runConvergencePhase :: Bool
If true, run the convergence phase.
runConvergenceMaxTime :: NominalDiffTime
Stop convergence once this much time has passed.
runResultAction :: (Int, Maybe Double) -> IO ()
Invoked for every runtime measured during the run. Can be used to provide a progress bar.

prepareBenchmarkProgram :: MonadIO m => Maybe Int -> CompileOptions -> FilePath -> [InputOutputs] -> m (Either (String, Maybe ByteString) ()) Source #

Compile and produce reference datasets.

data CompileOptions Source #

How to compile a benchmark.

Constructors

CompileOptions
Fields compFuthark :: String compBackend :: String compOptions :: [String]