Smartsim Documentation Refactor #463
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
This PR merges the Experiment.rst file into a branch that will encapsulate the entirety of the SmartSim documentation refactor. The Experiment.rst file offers documentation for an Experiment, a Launcher, the Experiment entities and an example demonstrating initializing, starting and stopping from within an experiment. The documentation is aimed to be accessible. [reviewed by @mellis13 @ashao @billschereriii @juliaputko ] [committed by @amandarichardsonn ]
This PR merges the logger document to the SmartSim docs feature branch. The logger document encompasses information and instruction to setup and use the SS logger. [ reviewed by @mellis13 @billschereriii @ankona @juliaputko ] [ committed by @amandarichardsonn ]
This PR merges into the feature branch documentation for run settings and batch settings. [ reviewed by @ankona @mellis13 @juliaputko @billschereriii ] [ committed by @amandarichardsonn ]
This branch will merge the Orchestrator documentation into the main SmartSim documentation branch. [ reviewed by @mellis13 @juliaputko @ankona @al-rigazzi ] [ committed by @amandarichardsonn ]
This PR requests the merge of the Model documentation section into the full craylab SmartSim doc refactor branch. [ reviewed by @mellis13 @ankona @juliaputko @al-rigazzi ] [ committed by @amandarichardsonn ]
This Pr merges the Ensemble documentation into the feature branch. [ reviewed by @mellis13 @ankona ] [ committed by @amandarichardsonn ]
ashao
requested changes
Feb 7, 2024
There was a problem hiding this comment.
Really excellent job on all the new content. In addition to the in-line comments, please address the following:
- All code snippets should be contained in their own files. The code revealed in the documentation should just be
includeliteralblocks - For each of these examples, at the top of their section include an expandable box that shows the full source code for that example
- Consider what information is redundant. Ensemble and Model in particular have a lot of overlapping material. Please include summaries and discuss what the difference is when interacting with an ensemble versus a model, but make use of references to reduce the amount of repeated material.
mellis13
requested changes
Feb 14, 2024
mellis13
requested changes
Feb 21, 2024
mellis13
requested changes
Feb 21, 2024
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #463 +/- ##
========================================
Coverage 90.75% 90.75%
========================================
Files 60 60
Lines 3839 3839
========================================
Hits 3484 3484
Misses 355 355
|
mellis13
approved these changes
Mar 12, 2024
amandarichardsonn
dismissed
ashao’s stale review
dismissing so that I may merge
Merged
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.
This PR provides a full refactor to the SmartSim documentation on craylabs.org. This branch merges in sections: Experiment, Orchestrator, Model, Ensemble, RunSettings, BatchSettings, and SmartSim Logging.