SmartSim Experiment docs #422
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## smartsim-docs-refresh #422 +/- ##
=========================================================
+ Coverage 90.34% 90.47% +0.13%
=========================================================
Files 60 60
Lines 3748 3738 -10
=========================================================
- Hits 3386 3382 -4
+ Misses 362 356 -6 |
billschereriii
suggested changes
Nov 30, 2023
ashao
requested changes
Dec 1, 2023
juliaputko
reviewed
Dec 14, 2023
doc/experiment.rst
Outdated
| steering, and more. The ``Orchestrator`` can be thought of as a general | ||
| feature store capable of storing numerical data, ML models, and scripts. | ||
| The orchestrator is capable of performing inference and script evaluation on feature | ||
| store data. Any SmartSim ``Model`` or ``Ensemble`` model can connect to the |
There was a problem hiding this comment.
'Any SmarSim model or Ensemble of models' ? Technically an ensemble is a group of models.
There was a problem hiding this comment.
I refer to a single ensemble model here since we can instruct a single ensemble model to connect to an orch, and then another does not need to!
mellis13
suggested changes
Dec 20, 2023
mellis13
suggested changes
Jan 3, 2024
|
|
||
| .. code-block:: bash | ||
| If the systems launcher cannot be found or no `launcher` argument is provided, the default value of | ||
| `launcher="local"` will be used. |
There was a problem hiding this comment.
@al-rigazzi Do we have.a method for viewing the launcher that is chosen by the auto feature? I only see the private member attribute Experiment._launcher.
mellis13
suggested changes
Jan 5, 2024
mellis13
suggested changes
Jan 5, 2024
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 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.