Update documentation #21
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
docs/src/results_store.md
Outdated
| Reefmod Engine Outputs and scenario information are recorded from the ReefMod Engine API | ||
| after each scenario(s) run, not before. | ||
|
|
||
| ## ResultStore Struct |
There was a problem hiding this comment.
Suggested change
| ## ResultStore Struct | |
| ## Result Store |
Struct is an implementation detail that doesn't feel right to have in user-facing documentation.
Also, "Result Store", "results store", "ResultStore", pick one and use it consistently throughout 😸
ConnectedSystems
requested changes
Oct 8, 2024
docs/src/results_store.md
Outdated
| dataframe and results YAX dataset. This is because the api forces counterfactuals to be | ||
| evaluated with every intervention run. | ||
|
|
||
| Model inputs are stored in the`results` field of the store and contains the following |
There was a problem hiding this comment.
Model inputs are stored in "results"? Is that correct? And if so, isn't that confusing?
There was a problem hiding this comment.
We can probably more dhw and cyclone category to a different field or rename the field
Handle cases where there are no intervention scenarios
change save_result_store argument order
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.
Add documentation for the results store.