cli progress bar benchmark

Introduction

We make sure that the timer is not TRUE, by setting it to ten hours.

library(cli)
# 10 hours
cli:::cli_tick_set(10 * 60 * 60 * 1000)
cli_tick_reset()
#> NULL
`__cli_update_due`
#> [1] FALSE

R benchmarks

The timer

fun <- function() NULL
ben_st <- bench::mark(
  `__cli_update_due`,
  fun(),
  .Call(ccli_tick_reset),
  interactive(),
  check = FALSE
)
ben_st
#> # A tibble: 4 × 6
#>   expression                  min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr>             <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 __cli_update_due        18.86ns   29.9ns 38383976.        0B        0
#> 2 fun()                  140.05ns  160.1ns  4470612.        0B        0
#> 3 .Call(ccli_tick_reset) 110.01ns  121.1ns  7838840.        0B        0
#> 4 interactive()            8.96ns     20ns 63001649.        0B        0

ben_st2 <- bench::mark(
  if (`__cli_update_due`) foobar()
)
ben_st2
#> # A tibble: 1 × 6
#>   expression                       min median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr>                     <bch> <bch:>     <dbl> <bch:byt>    <dbl>
#> 1 if (`__cli_update_due`) fooba…  49ns 60.1ns 17393447.        0B        0

`cli_progress_along()`

seq <- 1:100000
ta <- cli_progress_along(seq)
bench::mark(seq[[1]], ta[[1]])
#> # A tibble: 2 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 seq[[1]]      130ns    150ns  6293976.        0B        0
#> 2 ta[[1]]       150ns    171ns  4409354.        0B        0

`for` loop

This is the baseline:

f0 <- function(n = 1e5) {
  x <- 0
  seq <- 1:n
  for (i in seq) {
    x <- x + i %% 2
  }
  x
}

With progress bars:

fp <- function(n = 1e5) {
  x <- 0
  seq <- 1:n
  for (i in cli_progress_along(seq)) {
    x <- x + seq[[i]] %% 2
  }
  x
}

Overhead per iteration:

ben_taf <- bench::mark(f0(), fp())
ben_taf
#> # A tibble: 2 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0()         13.1ms   13.1ms      76.5    25.2KB    2296.
#> 2 fp()         16.2ms   16.2ms      61.6    83.2KB    1602.
(ben_taf$median[2] - ben_taf$median[1]) / 1e5
#> [1] 31.6ns

ben_taf2 <- bench::mark(f0(1e6), fp(1e6))
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_taf2
#> # A tibble: 2 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0(1e+06)     145ms    157ms      5.85        0B     56.5
#> 2 fp(1e+06)     172ms    175ms      5.70    1.87KB     55.1
(ben_taf2$median[2] - ben_taf2$median[1]) / 1e6
#> [1] 18.1ns

ben_taf3 <- bench::mark(f0(1e7), fp(1e7))
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_taf3
#> # A tibble: 2 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0(1e+07)     1.57s    1.57s     0.635        0B     35.6
#> 2 fp(1e+07)     1.68s    1.68s     0.595    1.87KB     33.3
(ben_taf3$median[2] - ben_taf3$median[1]) / 1e7
#> [1] 10.5ns

ben_taf4 <- bench::mark(f0(1e8), fp(1e8))
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_taf4
#> # A tibble: 2 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0(1e+08)     15.2s    15.2s    0.0657        0B     42.2
#> 2 fp(1e+08)     17.4s    17.4s    0.0574    1.87KB     35.6
(ben_taf4$median[2] - ben_taf4$median[1]) / 1e8
#> [1] 22ns

Mapping with `lapply()`

This is the baseline:

f0 <- function(n = 1e5) {
  seq <- 1:n
  ret <- lapply(seq, function(x) {
    x %% 2
  })
  invisible(ret)
}

With an index vector:

f01 <- function(n = 1e5) {
  seq <- 1:n
  ret <- lapply(seq_along(seq), function(i) {
    seq[[i]] %% 2
  })
  invisible(ret)
}

With progress bars:

fp <- function(n = 1e5) {
  seq <- 1:n
  ret <- lapply(cli_progress_along(seq), function(i) {
    seq[[i]] %% 2
  })
  invisible(ret)
}

Overhead per iteration:

ben_tam <- bench::mark(f0(), f01(), fp())
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_tam
#> # A tibble: 3 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0()         73.9ms   80.4ms     12.1      781KB     17.3
#> 2 f01()       109.2ms  113.9ms      8.38     781KB     13.4
#> 3 fp()        114.9ms  127.3ms      7.28     783KB     14.6
(ben_tam$median[3] - ben_tam$median[1]) / 1e5
#> [1] 469ns

ben_tam2 <- bench::mark(f0(1e6), f01(1e6), fp(1e6))
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_tam2
#> # A tibble: 3 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0(1e+06)  755.09ms 755.09ms     1.32     7.63MB     3.97
#> 2 f01(1e+06)    1.11s    1.11s     0.900    7.63MB     3.60
#> 3 fp(1e+06)     1.07s    1.07s     0.937    7.63MB     4.69
(ben_tam2$median[3] - ben_tam2$median[1]) / 1e6
#> [1] 312ns
(ben_tam2$median[3] - ben_tam2$median[2]) / 1e6
#> [1] 1ns

Mapping with purrr

This is the baseline:

f0 <- function(n = 1e5) {
  seq <- 1:n
  ret <- purrr::map(seq, function(x) {
    x %% 2
  })
  invisible(ret)
}

With index vector:

f01 <- function(n = 1e5) {
  seq <- 1:n
  ret <- purrr::map(seq_along(seq), function(i) {
    seq[[i]] %% 2
  })
  invisible(ret)
}

With progress bars:

fp <- function(n = 1e5) {
  seq <- 1:n
  ret <- purrr::map(cli_progress_along(seq), function(i) {
    seq[[i]] %% 2
  })
  invisible(ret)
}

Overhead per iteration:

ben_pur <- bench::mark(f0(), f01(), fp())
ben_pur
#> # A tibble: 3 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0()         66.9ms   67.2ms      14.9     884KB     8.92
#> 2 f01()        76.4ms   77.2ms      12.9     781KB     9.66
#> 3 fp()           81ms     82ms      12.0     783KB     6.02
(ben_pur$median[3] - ben_pur$median[1]) / 1e5
#> [1] 148ns
(ben_pur$median[3] - ben_pur$median[2]) / 1e5
#> [1] 48ns

ben_pur2 <- bench::mark(f0(1e6), f01(1e6), fp(1e6))
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_pur2
#> # A tibble: 3 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0(1e+06)  787.47ms 787.47ms     1.27     7.63MB     2.54
#> 2 f01(1e+06)    1.01s    1.01s     0.988    7.63MB     3.95
#> 3 fp(1e+06)     1.26s    1.26s     0.792    7.63MB     2.38
(ben_pur2$median[3] - ben_pur2$median[1]) / 1e6
#> [1] 475ns
(ben_pur2$median[3] - ben_pur2$median[2]) / 1e6
#> [1] 250ns

`ticking()`

f0 <- function(n = 1e5) {
  i <- 0
  x <- 0 
  while (i < n) {
    x <- x + i %% 2
    i <- i + 1
  }
  x
}

fp <- function(n = 1e5) {
  i <- 0
  x <- 0 
  while (ticking(i < n)) {
    x <- x + i %% 2
    i <- i + 1
  }
  x
}

ben_tk <- bench::mark(f0(), fp())
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_tk
#> # A tibble: 2 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0()         21.2ms   23.2ms    42.1      40.3KB     1.91
#> 2 fp()           5.5s     5.5s     0.182   100.8KB     2.00
(ben_tk$median[2] - ben_tk$median[1]) / 1e5
#> [1] 54.8µs

Traditional API

f0 <- function(n = 1e5) {
  x <- 0
  for (i in 1:n) {
    x <- x + i %% 2
  }
  x
}

fp <- function(n = 1e5) {
  cli_progress_bar(total = n)
  x <- 0
  for (i in 1:n) {
    x <- x + i %% 2
    cli_progress_update()
  }
  x
}

ff <- function(n = 1e5) {
  cli_progress_bar(total = n)
  x <- 0
  for (i in 1:n) {
    x <- x + i %% 2
    if (`__cli_update_due`) cli_progress_update()
  }
  x
}

ben_api <- bench::mark(f0(), ff(), fp())
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_api
#> # A tibble: 3 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0()         20.5ms   22.5ms    41.7      19.9KB     5.69
#> 2 ff()           19ms   19.4ms    47.7      28.6KB     3.97
#> 3 fp()           2.2s     2.2s     0.455      26KB     2.27
(ben_api$median[3] - ben_api$median[1]) / 1e5
#> [1] 21.8µs
(ben_api$median[2] - ben_api$median[1]) / 1e5
#> [1] 1ns

ben_api2 <- bench::mark(f0(1e6), ff(1e6), fp(1e6))
#> Warning: Some expressions had a GC in every iteration; so filtering is
#> disabled.
ben_api2
#> # A tibble: 3 × 6
#>   expression      min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr> <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 f0(1e+06)   199.1ms  223.1ms    4.50          0B     4.50
#> 2 ff(1e+06)   210.5ms  222.4ms    4.19      1.87KB     4.19
#> 3 fp(1e+06)     23.3s    23.3s    0.0429    1.87KB     2.23
(ben_api2$median[3] - ben_api2$median[1]) / 1e6
#> [1] 23.1µs
(ben_api2$median[2] - ben_api2$median[1]) / 1e6
#> [1] 1ns

C benchmarks

Baseline function:

SEXP test_baseline() {
  int i;
  int res = 0;
  for (i = 0; i < 2000000000; i++) {
    res += i % 2;
  }
  return ScalarInteger(res);
}

Switch + modulo check:

SEXP test_modulo(SEXP progress) {
  int i;
  int res = 0;
  int progress_ = LOGICAL(progress)[0];
  for (i = 0; i < 2000000000; i++) {
    if (i % 10000 == 0 && progress_) cli_progress_set(R_NilValue, i);
    res += i % 2;
  }
  return ScalarInteger(res);
}

cli progress bar API:

SEXP test_cli() {
  int i;
  int res = 0;
  SEXP bar = PROTECT(cli_progress_bar(2000000000, NULL));
  for (i = 0; i < 2000000000; i++) {
    if (CLI_SHOULD_TICK) cli_progress_set(bar, i);
    res += i % 2;
  }
  cli_progress_done(bar);
  UNPROTECT(1);
  return ScalarInteger(res);
}

SEXP test_cli_unroll() {
  int i = 0;
  int res = 0;
  SEXP bar = PROTECT(cli_progress_bar(2000000000, NULL));
  int s, final, step = 2000000000 / 100000;
  for (s = 0; s < 100000; s++) {
    if (CLI_SHOULD_TICK) cli_progress_set(bar, i);
    final = (s + 1) * step;
    for (i = s * step; i < final; i++) {
      res += i % 2;
    }
  }
  cli_progress_done(bar);
  UNPROTECT(1);
  return ScalarInteger(res);
}

library(progresstest)
ben_c <- bench::mark(
  test_baseline(),
  test_modulo(),
  test_cli(),
  test_cli_unroll()
)
ben_c
#> # A tibble: 4 × 6
#>   expression             min   median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr>        <bch:tm> <bch:tm>     <dbl> <bch:byt>    <dbl>
#> 1 test_baseline()    620.5ms  620.5ms     1.61     2.08KB        0
#> 2 test_modulo()        1.25s    1.25s     0.802    2.24KB        0
#> 3 test_cli()           1.25s    1.25s     0.800   23.67KB        0
#> 4 test_cli_unroll() 619.21ms 619.21ms     1.61     3.34KB        0
(ben_c$median[3] - ben_c$median[1]) / 2000000000
#> [1] 1ns

Display update

We only update the display a fixed number of times per second. (Currently maximum five times per second.)

Let’s measure how long a single update takes.

Iterator with a bar

cli_progress_bar(total = 100000)
bench::mark(cli_progress_update(force = TRUE), max_iterations = 10000)
#> ■                                  0% | ETA:  5m
#> ■                                  0% | ETA:  2h
#> ■                                  0% | ETA:  1h
#> ■                                  0% | ETA:  1h
#> ■                                  0% | ETA:  1h
#> ■                                  0% | ETA: 45m
#> ■                                  0% | ETA: 40m
#> ■                                  0% | ETA: 36m
#> ■                                  0% | ETA: 34m
#> ■                                  0% | ETA: 31m
#> ■                                  0% | ETA: 29m
#> ■                                  0% | ETA: 28m
#> ■                                  0% | ETA: 26m
#> ■                                  0% | ETA: 25m
#> ■                                  0% | ETA: 24m
#> ■                                  0% | ETA: 23m
#> ■                                  0% | ETA: 22m
#> ■                                  0% | ETA: 22m
#> ■                                  0% | ETA: 21m
#> ■                                  0% | ETA: 20m
#> ■                                  0% | ETA: 20m
#> ■                                  0% | ETA: 19m
#> ■                                  0% | ETA: 19m
#> ■                                  0% | ETA: 19m
#> ■                                  0% | ETA: 18m
#> ■                                  0% | ETA: 18m
#> ■                                  0% | ETA: 18m
#> ■                                  0% | ETA: 17m
#> ■                                  0% | ETA: 17m
#> ■                                  0% | ETA: 17m
#> ■                                  0% | ETA: 17m
#> ■                                  0% | ETA: 16m
#> ■                                  0% | ETA: 16m
#> ■                                  0% | ETA: 16m
#> ■                                  0% | ETA: 16m
#> ■                                  0% | ETA: 16m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 15m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 14m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 13m
#> ■                                  0% | ETA: 12m
#> ■                                  0% | ETA: 12m
#> ■                                  0% | ETA: 12m
#> ■                                  0% | ETA: 12m
#> ■                                  0% | ETA: 12m
#> ■                                  0% | ETA: 12m
#> # A tibble: 1 × 6
#>   expression                       min median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr>                    <bch:> <bch:>     <dbl> <bch:byt>    <dbl>
#> 1 cli_progress_update(force = … 5.72ms 5.81ms      169.    1.34MB     2.04
cli_progress_done()

Iterator without a bar

cli_progress_bar(total = NA)
bench::mark(cli_progress_update(force = TRUE), max_iterations = 10000)
#> ⠙ 1 done (418/s) | 3ms
#> ⠹ 2 done (73/s) | 28ms
#> ⠸ 3 done (87/s) | 35ms
#> ⠼ 4 done (96/s) | 42ms
#> ⠴ 5 done (103/s) | 49ms
#> ⠦ 6 done (109/s) | 56ms
#> ⠧ 7 done (113/s) | 63ms
#> ⠇ 8 done (116/s) | 69ms
#> ⠏ 9 done (119/s) | 76ms
#> ⠋ 10 done (121/s) | 83ms
#> ⠙ 11 done (123/s) | 90ms
#> ⠹ 12 done (125/s) | 97ms
#> ⠸ 13 done (126/s) | 104ms
#> ⠼ 14 done (127/s) | 111ms
#> ⠴ 15 done (129/s) | 117ms
#> ⠦ 16 done (130/s) | 124ms
#> ⠧ 17 done (131/s) | 131ms
#> ⠇ 18 done (131/s) | 138ms
#> ⠏ 19 done (132/s) | 145ms
#> ⠋ 20 done (133/s) | 151ms
#> ⠙ 21 done (133/s) | 158ms
#> ⠹ 22 done (134/s) | 165ms
#> ⠸ 23 done (134/s) | 172ms
#> ⠼ 24 done (135/s) | 178ms
#> ⠴ 25 done (135/s) | 185ms
#> ⠦ 26 done (136/s) | 192ms
#> ⠧ 27 done (136/s) | 199ms
#> ⠇ 28 done (137/s) | 206ms
#> ⠏ 29 done (137/s) | 212ms
#> ⠋ 30 done (137/s) | 220ms
#> ⠙ 31 done (137/s) | 227ms
#> ⠹ 32 done (137/s) | 234ms
#> ⠸ 33 done (137/s) | 241ms
#> ⠼ 34 done (138/s) | 247ms
#> ⠴ 35 done (138/s) | 254ms
#> ⠦ 36 done (138/s) | 261ms
#> ⠧ 37 done (138/s) | 268ms
#> ⠇ 38 done (139/s) | 275ms
#> ⠏ 39 done (139/s) | 281ms
#> ⠋ 40 done (139/s) | 288ms
#> ⠙ 41 done (139/s) | 295ms
#> ⠹ 42 done (139/s) | 302ms
#> ⠸ 43 done (140/s) | 309ms
#> ⠼ 44 done (140/s) | 315ms
#> ⠴ 45 done (140/s) | 322ms
#> ⠦ 46 done (140/s) | 329ms
#> ⠧ 47 done (140/s) | 336ms
#> ⠇ 48 done (140/s) | 343ms
#> ⠏ 49 done (140/s) | 350ms
#> ⠋ 50 done (140/s) | 357ms
#> ⠙ 51 done (140/s) | 364ms
#> ⠹ 52 done (141/s) | 371ms
#> ⠸ 53 done (141/s) | 378ms
#> ⠼ 54 done (141/s) | 384ms
#> ⠴ 55 done (141/s) | 391ms
#> ⠦ 56 done (141/s) | 398ms
#> ⠧ 57 done (139/s) | 409ms
#> ⠇ 58 done (140/s) | 416ms
#> ⠏ 59 done (140/s) | 423ms
#> ⠋ 60 done (140/s) | 430ms
#> ⠙ 61 done (140/s) | 437ms
#> ⠹ 62 done (140/s) | 443ms
#> ⠸ 63 done (140/s) | 450ms
#> ⠼ 64 done (140/s) | 457ms
#> ⠴ 65 done (140/s) | 464ms
#> ⠦ 66 done (140/s) | 471ms
#> ⠧ 67 done (140/s) | 478ms
#> ⠇ 68 done (140/s) | 485ms
#> ⠏ 69 done (141/s) | 492ms
#> ⠋ 70 done (141/s) | 498ms
#> ⠙ 71 done (141/s) | 505ms
#> ⠹ 72 done (141/s) | 512ms
#> ⠸ 73 done (141/s) | 519ms
#> ⠼ 74 done (141/s) | 526ms
#> # A tibble: 1 × 6
#>   expression                       min median `itr/sec` mem_alloc `gc/sec`
#>   <bch:expr>                    <bch:> <bch:>     <dbl> <bch:byt>    <dbl>
#> 1 cli_progress_update(force = … 6.74ms 6.83ms      146.     198KB     2.03
cli_progress_done()

Gábor Csárdi

2023-12-11

Introduction

R benchmarks

The timer

`cli_progress_along()`

`for` loop

Mapping with `lapply()`

Mapping with purrr

`ticking()`

Traditional API

C benchmarks

Display update

Iterator with a bar

Iterator without a bar

cli progress bar benchmark

Gábor Csárdi

2023-12-11

Introduction

R benchmarks

The timer

cli_progress_along()

for loop

Mapping with lapply()

Mapping with purrr

ticking()

Traditional API

C benchmarks

Display update

Iterator with a bar

Iterator without a bar

`cli_progress_along()`

`for` loop

Mapping with `lapply()`

`ticking()`