Skip to content

Commit 7730e61

Browse files
mrzkpkjjarvis
authored andcommitted
Apply suggestions from code review
Co-authored-by: Katy Jarvis <55932920+kjjarvis@users.noreply.github.com>
1 parent 576c91a commit 7730e61

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

examples/benchmarking.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"cell_type": "markdown",
2323
"metadata": {},
2424
"source": [
25-
"The goal of this notebook is to demonstrate the Benchmarking feature offered for Prognostic Models. Specifically, we will demonstrate via a simple example how to benchmark the computational efficiency of models!"
25+
"The goal of this notebook is to demonstrate the Benchmarking feature offered for Prognostic Models. Specifically, we will demonstrate how to benchmark the computational efficiency of models with a simple example."
2626
]
2727
},
2828
{
@@ -56,7 +56,7 @@
5656
"cell_type": "markdown",
5757
"metadata": {},
5858
"source": [
59-
"Next, let's initialize our Battery Circuit by creating model object."
59+
"Next, let's initialize our Battery Circuit by creating a model object."
6060
]
6161
},
6262
{
@@ -74,7 +74,7 @@
7474
"cell_type": "markdown",
7575
"metadata": {},
7676
"source": [
77-
"Then, for our model, we would need to define a future loading function. More information on what a future loading function is and how to use it can be found here: https://nasa.github.io/progpy/prog_models_guide.html#future-loading"
77+
"Then, for our model, we will need to define a future loading function. More information on what a future loading function is and how to use it can be found here: https://nasa.github.io/progpy/prog_models_guide.html#future-loading"
7878
]
7979
},
8080
{
@@ -103,9 +103,9 @@
103103
"cell_type": "markdown",
104104
"metadata": {},
105105
"source": [
106-
"Finally, we are going to need to benchmark the simulation!\n",
106+
"Finally, we are ready to benchmark the simulation.\n",
107107
"\n",
108-
"We can do this by using the `timeit()` function and pass in our `simulate_to()` or `simulate_to_threshold()` function for the `stmt` argument. For more information regarding the `timeit()` function, please read it's documentation located here: https://docs.python.org/3/library/timeit.html"
108+
"We can do this by using the `timeit()` function and pass in our `simulate_to()` or `simulate_to_threshold()` function for the `stmt` argument. For more information regarding the `timeit()` function, please read its documentation located here: https://docs.python.org/3/library/timeit.html"
109109
]
110110
},
111111
{
@@ -125,7 +125,7 @@
125125
"cell_type": "markdown",
126126
"metadata": {},
127127
"source": [
128-
"In this example, we would be benchmarking the simulation for the BatteryCircuit model up to 600 seconds. Furthermore, we will define our `number` argument to be 500 for sake of runtime."
128+
"In this example, we are benchmarking the simulation for the BatteryCircuit model up to 600 seconds. Furthermore, we define our `number` argument to be 500 for sake of runtime."
129129
]
130130
},
131131
{

0 commit comments

Comments
 (0)