Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme Update #136

Merged
merged 10 commits into from
Feb 10, 2022
Merged

Readme Update #136

merged 10 commits into from
Feb 10, 2022

Conversation

MattToast
Copy link
Member

Updates to the SmartSim README for upcoming release.

  • Update examples to use new experiment api (create_run_settings, create_batch_settings)
  • Update supported ML backend versions
  • Add clarify info to examples where I though useful
  • Spelling/typos/grammar

Copy link
Collaborator

@al-rigazzi al-rigazzi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good job, just a couple of minor typos remaining, otherwise LGTM

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@Spartee Spartee self-requested a review February 4, 2022 02:37
Copy link
Contributor

@Spartee Spartee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ben-albrecht
Copy link
Contributor

ben-albrecht commented Feb 8, 2022

I ran scspell on this branch's README and caught a few more typos:

diff --git a/README.md b/README.md
index 3822d24..5cd9d8d 100644
--- a/README.md
+++ b/README.md
@@ -74,7 +74,7 @@ TODO: Check if new table is what is expected
       <td>1.7.0</td>
     </tr>
     <tr>
-      <td>Tensorlow\Keras</td>
+      <td>Tensorflow\Keras</td>
       <td>2.5.2</td>
     </tr>
     <tr>
@@ -86,7 +86,7 @@ TODO: Check if new table is what is expected
       <td>1.9.1</td>
     </tr>
     <tr>
-      <td>Tensorlow\Keras</td>
+      <td>Tensorflow\Keras</td>
       <td>2.6.2</td>
     </tr>
     <tr>
@@ -455,7 +455,7 @@ db_cluster = PBSOrchestrator(db_nodes=3, db_port=6780, batch=True,
 exp.start(db_cluster)
 
 print(f"Orchestrator launched on nodes: {db_cluster.hosts}")
-# launch models, anaylsis, training, inference sessions, etc
+# launch models, analysis, training, inference sessions, etc
 # that communicate with the database using the SmartRedis clients
 
 exp.stop(db_cluster)
@@ -598,7 +598,7 @@ scripts if there is no database for them to connect to.
 The example below shows how to take a PyTorch model, send it to the Orchestrator, and
 execute it on data stored within the database.
 
-Notice that when we set the model in the database, we set the device arguement to
+Notice that when we set the model in the database, we set the device argument to
 **GPU**. By doing this we ensure that execution of the model takes place on a GPU if
 one is available to the database.
 
@@ -927,7 +927,7 @@ TODO: Again confirm that this should be replaced with new table
       <td>1.7.0</td>
     </tr>
     <tr>
-      <td>Tensorlow\Keras</td>
+      <td>Tensorflow\Keras</td>
       <td>2.5.2</td>
     </tr>
     <tr>
@@ -939,7 +939,7 @@ TODO: Again confirm that this should be replaced with new table
       <td>1.9.1</td>
     </tr>
     <tr>
-      <td>Tensorlow\Keras</td>
+      <td>Tensorflow\Keras</td>
       <td>2.6.2</td>
     </tr>
     <tr>

@MattToast
Copy link
Member Author

@ben-albrecht Thanks for the catch! Fixed in latest commit

@Spartee Spartee added area: docs Issues related to documentation type: chore Issue outside of general development labels Feb 10, 2022
@MattToast MattToast merged commit b66b077 into CrayLabs:develop Feb 10, 2022
@MattToast MattToast deleted the readme-update branch February 11, 2022 22:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Issues related to documentation type: chore Issue outside of general development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants