Repository navigation
Follow-ups for #984: name every sorted result file, credit srivarshni7 (waiting on sign-off) - #1016
Draft
wshlavacek wants to merge 3 commits into
Draft
wshlavacek wants to merge 3 commits into
wshlavacek wants to merge 3 commits into
Conversation
… case-sensitive (#932) The starting_params entry now lists the three files whose parameter columns are sorted: samples.txt, sorted_params*.txt and bootstrapped_parameter_sets.txt. The glob is sorted_params*.txt so that it also covers plain sorted_params.txt, which is written when delete_old_files >= 2. The bootstrap file goes through the same Trajectory writer as sorted_params, so it is sorted too. The sort is Python's case-sensitive string order. Parameters declared kcat, Km, alpha are written Km, alpha, kcat, so "alphabetical" would have sent a reader looking for alpha, kcat, Km. The entry also says that start_point is not a drop-in replacement for starting_params on a sampler. start_point pins only the first chain, and starting_params sets every chain. tests/test_result_file_parameter_order.py pins every order the docs state: - samples.txt, sorted_params_final.txt, sorted_params.txt, each Results-boot{N}/sorted_params.txt and bootstrapped_parameter_sets.txt are sorted; - start_point.txt, the credible rows and am's params_0.txt are in declaration order; - starting_params is applied in declaration order; - continue_run = 1 overrides starting_params. The expected orders are written out by hand. The boxes do not overlap, so a value written under the wrong header falls outside its box. Signed-off-by: Bill Hlavacek <bill.hlavacek@gmail.com>
Signed-off-by: Bill Hlavacek <bill.hlavacek@gmail.com>
This branch has not been deployed
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
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.
Draft. Do not merge this PR. It tracks the maintainer follow-ups to #984, and runs CI on them, while #984 waits for the contributor's sign-off (request). When the sign-off arrives, these commits go onto #984's branch and #984 is the PR that merges, so the contributor keeps the credit.
Commits
6c04ed2starting_paramsentry names the sorted files instead of saying "every result file" is sorted (#932)720609asamples.txt,sorted_params*.txt,bootstrapped_parameter_sets.txt), says the sort is case-sensitive, and saysstart_pointpins only a sampler's first chain. Addstests/test_result_file_parameter_order.py1d1f8d4When the sign-off lands
720609aand1d1f8d4onto Clarify alphabetical ordering in starting_params docs #984's signed-off commitsrivarshni7:patch-1(maintainer edits are allowed)contrib/984-followupsHow it was checked
sorted(). The three parameters have non-overlapping boxes, so a value under the wrong header falls outside the box that header names. Four deliberate breakages of the writers were each caught: a case-insensitive sort, values out of step with the header,starting_paramsapplied in reverse, andstarting_paramswinning overcontinue_run.Trajectory, which writessorted_params*andbootstrapped_parameter_sets.txt, and the sampler'ssamples.txtwriter. Every other writer that lists parameters follows declaration order. That coversstart_point.txt,credible*.txt,diagnostics.txt, theamfiles underA_MCMC/andadaptive_files/, and the Liu–West filter tables. This was confirmed by realde,mh,am,continue_runandbootstrapruns with parameters declaredkcat,Km,alpha.pybnf/, so no changelog fragment is needed.test_adaptive_mcmc.py(58 passed).ruff@0.15.14andsphinx-build -Ware clean.Refs #932, #984.