From 4701e8c1e066372f1dca870636f20eee36074114 Mon Sep 17 00:00:00 2001 From: Jemma Stachelek Date: Tue, 29 Oct 2024 10:13:47 -0600 Subject: [PATCH] Fix typos in documentation (#758) Fix typos in documentation [ reviewed by @ankona ] [ committed by @jsta ] --- doc/changelog.md | 2 ++ doc/tutorials/ml_training/surrogate/README.md | 4 ++-- doc/tutorials/ml_training/surrogate/train_surrogate.ipynb | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/changelog.md b/doc/changelog.md index 8f93a1ae2c..b2bf0152d5 100644 --- a/doc/changelog.md +++ b/doc/changelog.md @@ -15,6 +15,7 @@ Description - Implement workaround for Tensorflow that allows RedisAI to build with GCC-14 - Add instructions for installing SmartSim on PML's Scylla +- Fix typos in documentation Detailed Notes @@ -30,6 +31,7 @@ Detailed Notes have yet to be installed at a system-wide level. Scylla has its own entry in the documentation. ([SmartSim-PR733](https://github.com/CrayLabs/SmartSim/pull/733)) +- Fix typos in the `train_surrogate` tutorial documentation ### 0.8.0 diff --git a/doc/tutorials/ml_training/surrogate/README.md b/doc/tutorials/ml_training/surrogate/README.md index 823d27500b..ea2e8a68ff 100644 --- a/doc/tutorials/ml_training/surrogate/README.md +++ b/doc/tutorials/ml_training/surrogate/README.md @@ -3,6 +3,6 @@ In this example, a neural network is trained to act like a surrogate model and to solve a well-known physical problem, i.e. computing the steady state of heat diffusion. The training -dataset is constructed by running simualations *while* the model is being trained. +dataset is constructed by running simulations *while* the model is being trained. -The notebook also displays how the surrogate model prediction improves during training. \ No newline at end of file +The notebook also displays how the surrogate model prediction improves during training. diff --git a/doc/tutorials/ml_training/surrogate/train_surrogate.ipynb b/doc/tutorials/ml_training/surrogate/train_surrogate.ipynb index 5625b86b99..76a7b8c05f 100644 --- a/doc/tutorials/ml_training/surrogate/train_surrogate.ipynb +++ b/doc/tutorials/ml_training/surrogate/train_surrogate.ipynb @@ -15,7 +15,7 @@ "\n", "In this notebook, a neural network is trained to act like a surrogate model and to solve a\n", "well-known physical problem, i.e. computing the steady state of heat diffusion. The training\n", - "dataset is constructed by running simualations *while* the model is being trained.\n", + "dataset is constructed by running simulations *while* the model is being trained.\n", "\n", "## 2D Heat Diffusion and Steady State\n", "Throughout this notebook, the heat equation will be solved on the two-dimensional domain $[0,1]\\times[0,1]$, setting the initial temperature to 0 K, except\n",