Return time in read_cmdstan_csv for MCMC #414
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #414 +/- ##
==========================================
+ Coverage 88.19% 88.29% +0.10%
==========================================
Files 12 12
Lines 2769 2793 +24
==========================================
+ Hits 2442 2466 +24
Misses 327 327
Continue to review full report at Codecov.
|
jgabry
approved these changes
Dec 20, 2020
Comment on lines
+517
to
+518
| #' * `total`: (scalar) The total run time. For MCMC this may be different than | ||
| #' the sum of the chain run times if parallelization was used. |
There was a problem hiding this comment.
I added this clarification in the fit$time() doc
| @@ -321,6 +331,7 @@ read_cmdstan_csv <- function(files, | |||
| } | |||
| list( | |||
| metadata = metadata, | |||
| time = list(total = NA_integer_, chains = time), | |||
There was a problem hiding this comment.
this keeps the structure consistent with the output of fit$time() but total is NA because we can't infer it from the CSV files
Comment on lines
+31
to
+34
| #' * `time`: Run time information for the individual chains. The returned object | ||
| #' is the same as for the [$time()][fit-method-time] method except the total run | ||
| #' time can't be inferred from the CSV files (the chains may have been run in | ||
| #' parallel) and is therefore `NA`. |
There was a problem hiding this comment.
Added some doc for the time component of the returned list
2 tasks
|
Thanks. I agree with all changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
read_cmdstan_csv now returns time if MCMC CSVs are used.
Copyright and Licensing
Please list the copyright holder for the work you are submitting
(this will be you or your assignee, such as a university or company):
Rok Češnovar
By submitting this pull request, the copyright holder is agreeing to
license the submitted work under the following licenses: