package jupyter

  1. Overview
  2. Docs
An OCaml kernel for Jupyter

Install 

dune-project
 Dependency

akabe.github.io Readme Edit opam file Versions (17)

Authors

  1. A
    Akinori ABE

Maintainers

  1. E
    Eugene Lykhovyd <eugene@lykhovyd.com>

Sources

v3.0.1.tar.gz
md5=27079d43a5134a740428623185807029
sha512=40929cacd1ddc0379c84438bcda3edce47ab571ea27ff5f597b5e88fc38c9198cc69442e334e05c64d854763c162c2e8266497dbc413134beb71db00d11df6ce

doc/jupyter.notebook/Jupyter_notebook/Bench/index.html

Module Jupyter_notebook.BenchSource

Benchmark functions

Types

Sourcetype 'a t = {
  1. b_rtime : 'a;
    (*

    Real time for the process

    *)
  2. b_utime : 'a;
    (*

    User time for the process

    *)
  3. b_stime : 'a;
    (*

    System time for the process

    *)
}

The type of execution time of functions or code snippets.

'a is float or stat.

  • since 2.8.0
Sourcetype stat = {
  1. bs_mean : float;
    (*

    Mean of execution time per a loop

    *)
  2. bs_std : float;
    (*

    Standard deviation of execution time per a loop

    *)
}

The type of summary results of repeated measurement of execution time.

  • since 2.8.0

Benchmark

Sourceval time : (unit -> 'a) -> 'a * float t

time f measures execution time of a function f.

  • returns

    a pair of f () and a result of benchmark.

  • since 2.8.0
Sourceval timeit : ?runs:int -> ?loops_per_run:int -> ?before_run:(unit -> unit) -> ?after_run:(unit -> unit) -> (unit -> 'a) -> stat t

timeit ?runs ?loops_per_run ?before_run ?after_run f repeatedly executes a function f, and measures the mean and the standard deviation of each execution time of f ().

for i = 1 to runs do
    before_run () ;
    (* --- start measurement of execution time of each run --- *)
    for _ = 1 to loops_per_run do
      ignore (f ()) ;
    done ;
    (* --- finish measurement --- *)
    after_run () ;
  done

timeit is inspired by timeit package in Python. The parameter loops_per_run, before_run are named as number, setup respectively in Python.

  • parameter runs

    the number of running (default = 5)

  • parameter loops_per_run

    the number of loops per each run (default = 1,000,000)

  • parameter before_run

    function once called before each run.

  • parameter after_run

    function once called after each run.

  • returns

    summary of measurement.

  • since 2.8.0

Pretty printers

Sourceval pp : (Format.formatter -> 'a -> unit) -> Format.formatter -> 'a t -> unit
  • since 2.8.0
Sourceval pp_float_t : Format.formatter -> float t -> unit
  • since 2.8.0
Sourceval pp_timedelta : Format.formatter -> float -> unit
  • since 2.8.0
Sourceval pp_stat : Format.formatter -> stat -> unit
  • since 2.8.0