JuliaCI / JuliaCI/BenchmarkTools.jl

is this correct samples with seconds behavior? - better document effect of tuning

Open
#162 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Julia
Stars
684
Forks
107
PR merge metrics
No merged PRs in 30d

Description

function dosomething()
    sleep(1)
end
julia> @time @btime dosomething() samples=3 seconds=20
  1.002 s (7 allocations: 160 bytes)  # this is from btime
 26.740450 seconds (312.46 k allocations: 15.984 MiB, 1.59% gc time)  # this is from time

The documentation seems to imply that seconds is an upper bound on benchmarking, which leads me to believe that the proper behavior is to exit after n samples or m seconds, whichever comes first.

Am I misunderstanding how this works?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the documented @time @btime dosomething() samples=3 seconds=20 example and read the documentation describing samples and seconds. Confirm how the two timing macros apply those options, then update the documentation so the stopping behavior and the distinction between the displayed timings are unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation, performance
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.