Support various formats for progress rate string #228
Conversation
|
If there is anything else I need to do to merge this PR, please let me know. |
|
Looks like this is missing tests and documentation, at least. |
Done! Let me know if anything else is needed. |
|
@martinholters @timholy What are your thoughts on this PR? I personally am interested in using the |
| @@ -66,6 +94,7 @@ mutable struct Progress <: AbstractProgress | |||
| tlast::Float64 | |||
| printed::Bool # true if we have issued at least one status update | |||
| desc::String # prefix to the percentage, e.g. "Computing..." | |||
| rate_format::AbstractRateFormat | |||
There was a problem hiding this comment.
Should we introduce a type parameter to Progress so that rate_format can be concretely typed? Otherwise, the calls to rate_string would do dynamic dispatch. But maybe that is insignificant performance-wise compared to the IO. Could you benchmark an empty loop to see whether this PR incurs any relevant performance hit?
There was a problem hiding this comment.
Ooof. Yeah having the dynamic dispatch inside a hot loop sounds like a bad idea.
Instead of having rate_format::AbstractRateFormat, perhaps we could have a concretely-typed format_string::String?
There was a problem hiding this comment.
With the master branch:
julia> p = ProgressMeter.Progress(10000000);
julia> p.rate_format # master doesn't support rate format
ERROR: type Progress has no field rate_format
...
julia> @btime ProgressMeter.next!($p)
Progress: 100%|███████████████████████████████████████████████████████████████████████████████████████| Time: 0:00:02
16.335 ns (0 allocations: 0 bytes)With the present PR:
julia> p = ProgressMeter.Progress(10000000);
julia> p.rate_format # present PR supports rate format
PercentRateFormat(0)
julia> @btime ProgressMeter.next!($p)
Progress: 100%|███████████████████████████████████████████████████████████████████████████████████████| Time: 0:00:02
15.517 ns (0 allocations: 0 bytes)There doesn't seem any noticeable performance degradation.
There was a problem hiding this comment.
More informative might be something like this:
julia> p = ProgressMeter.Progress(10000000; dt=0.001);
julia> @bprofile ProgressMeter.next!($p)
Progress: 100%|█████████████████████████████████████████████████████████████████████████████████| Time: 0:00:02
BenchmarkTools.Trial: 10000 samples with 1000 evaluations.
Range (min … max): 5.342 ns … 624.207 ns ┊ GC (min … max): 0.00% … 0.00%
Time (median): 6.455 ns ┊ GC (median): 0.00%
Time (mean ± σ): 8.209 ns ± 15.537 ns ┊ GC (mean ± σ): 0.00% ± 0.00%
▄█▄▄▂ ▁
██████▆▅▆▇▆▆▆▅▅▅▄▅▃▃▁▄▃▁▃▄▃▃▃▃▃▁▁▁▃▃▄▁▄▁▃▁▄▃▁▃▁▃▁▁▄▁▄▅▅▄▄▄▄ █
5.34 ns Histogram: log(frequency) by time 55.2 ns <
Memory estimate: 0 bytes, allocs estimate: 0.Presumably the dispatch is only triggered when it prints?
|
Just resolved the conflicts with the newly released Version 1.7.2. Can this PR be merged now? This time I was able to resolve the conflicts with the newly released version, but I'm not sure if I could do so when the future versions introduce more complex conflicts. So, I hope this PR to be merged before the next version is released. Please let me know if there are additional concerns. Note that
|
|
What is the status on this pull request? I am very much looking forward to using this over percentage. |
There was a problem hiding this comment.
Sorry I was ignoring this and all my other packages while working on pkgimages for 1.9. This looks promising and I think we can merge it soon. I don't really expect a single runtime dispatch that happens only when printing occurs to be a big performance issue, but since the issue was raised perhaps we can get one more check?
| @@ -66,6 +94,7 @@ mutable struct Progress <: AbstractProgress | |||
| tlast::Float64 | |||
| printed::Bool # true if we have issued at least one status update | |||
| desc::String # prefix to the percentage, e.g. "Computing..." | |||
| rate_format::AbstractRateFormat | |||
There was a problem hiding this comment.
More informative might be something like this:
julia> p = ProgressMeter.Progress(10000000; dt=0.001);
julia> @bprofile ProgressMeter.next!($p)
Progress: 100%|█████████████████████████████████████████████████████████████████████████████████| Time: 0:00:02
BenchmarkTools.Trial: 10000 samples with 1000 evaluations.
Range (min … max): 5.342 ns … 624.207 ns ┊ GC (min … max): 0.00% … 0.00%
Time (median): 6.455 ns ┊ GC (median): 0.00%
Time (mean ± σ): 8.209 ns ± 15.537 ns ┊ GC (mean ± σ): 0.00% ± 0.00%
▄█▄▄▂ ▁
██████▆▅▆▇▆▆▆▅▅▅▄▅▃▃▁▄▃▁▃▄▃▃▃▃▃▁▁▁▃▃▄▁▄▁▃▁▄▃▁▃▁▃▁▁▄▁▄▅▅▄▄▄▄ █
5.34 ns Histogram: log(frequency) by time 55.2 ns <
Memory estimate: 0 bytes, allocs estimate: 0.Presumably the dispatch is only triggered when it prints?
|
Current plan: replace this implementation with one that is type-stable. E.g., struct RateFormat
format::Symbol
digits::Int # only used for certain `format`s
end |
This PR implements a support for various formats for the string indicating the progress rate. Currently, the string before the progress bar is in percent format (e.g., "20%"), but sometimes it is useful to know exactly how many items have been processed out of the total.
For example, if some parameter is being processed at 50 different values, but if the process is halted midway, you may want to resume the process from the halted value in order to save time. By showing the progress rate as "10/50" or "10 out of 50" instead of "20%", this PR allows the users to know exactly where the process stopped, so that s/he can modify the script to start from the halted value (in this case at the 5th value of the parameter).
Here are some example usages of the new feature:
This PR also provides a framework for the users to implement their own formats for the progress rate string by extending
AbstractRateFormatand implementing the correspondingrate_string()function. As an example, this PR implementsEmptyRateFormat, which does not pint out the progress ratePercentRateFormat(digits), wheredigitsindicates the number of digits below the decimal point in the percent format (e.g.,9.24%forPercenRateFormat(2))