Docs for data container and HPC #179
Merged
Conversation
This file contains 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
odunbar
changed the title
haakon-e
reviewed
Jul 23, 2022
There was a problem hiding this comment.
Overall great addition to the docs!
One major suggestion:
- I don't like that a lot of code is duplicated between
GModel_xx.jl. I feel like this obscures the actual differences between the parallelism options. Instead, I think the components that are identical should be stored in some common file and loaded into each of_distfor,_multithread, etc.
We could for example call this common fileGModel.jland rename the serial case e.g. toGModel_serial.jl.
I'm happy to review again once my comments and suggestions are addressed! :)
docs/src/data_wrappers.md
Outdated
|
|
||
| To provide a consistent form for data (such as observations, parameter ensembles, model evaluations) across the package, we store the data in simple wrappers internally. | ||
|
|
||
| Data is always stored as columns of `AbstractMatrix`. That is, we obey the format |
There was a problem hiding this comment.
Suggested change
| Data is always stored as columns of `AbstractMatrix`. That is, we obey the format | |
| Data is always stored column-wise in an `AbstractMatrix` subtype. That is, we obey the format |
looking at the constructor code, it appears we only enforce that data is a concrete subtype of AbstractMatrix, so data will be whatever concrete type was supplied upon construction
|
bors try |
tryBuild succeeded: |
haakon-e
reviewed
Jul 28, 2022
haakon-e
reviewed
Jul 28, 2022
haakon-e
approved these changes
Jul 28, 2022
Comment on lines
+74
to
+72
| Run the forward model G for an array of parameters by iteratively | ||
| calling run_G for each of the N_ensemble parameter values. | ||
| Return g_ens, an array of size N_data x N_ensemble, where | ||
| g_ens[:,j] = G(params[:,j]) |
There was a problem hiding this comment.
This isn't exactly correct in the current implementation, but I'm happy to leave this for a future PR that cleans up the runscript
parallel & hpc page added lorenz examples to supplement docs examples/Lorenz/distributed_Lorenz_example.jl format docs changes from review typo removed comment remove serial case, add else case format refactor distributed Lorenz example format adjusted docs to suit new code remove ... review comments consistent structure for GModel fixed broken link links to GModels typo
|
bors r+ |
|
Build succeeded: |
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.
Purpose and Content
add two docs pages requested in Issues #153 , closes #148
adds an example to demonstrate all of the different parallelism types (serial, multithread, pmap and distributed for)
distributed_Lorenz_example.jlPR Checklist