package octez-shell-libs

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Tezos_benchmark.Benchmark.Benchmark_base

Name of the benchmark

val info : string

Description of the benchmark

val module_filename : string

File where the benchmark module is defined

Described the purpose of the benchmark. * Generate_code of destination: generates code at the given destination file. * Other_purpose of purpose: any other purpose. The goal is to explain why the function is benchmarked since it does not produce a cost function.

val tags : string list

Tags of the benchmark

type config

Configuration of the benchmark (eg sampling parameters, paths, etc)

val default_config : config

Default configuration of the benchmark

val config_encoding : config Tezos_base.TzPervasives.Data_encoding.t

Configuration encoding

type workload

Benchmark workload

val workload_encoding : workload Tezos_base.TzPervasives.Data_encoding.t

Workload encoding

val workload_to_vector : workload -> Tezos_benchmark.Sparse_vec.String.t

Optional conversion to vector, for report generation purposes

Inference group of the benchmark

Model used for inference

val create_benchmark : rng_state:Stdlib.Random.State.t -> config -> workload Tezos_benchmark.Generator.benchmark

Creates a benchmark, ready to be run. The benchmarks are thunked to prevent evaluating the workload until needed.

OCaml

Innovation. Community. Security.