Skip to content

Commit 5309a9b

Browse files
mrzkpteubert
andauthored
Apply suggestions from code review
Co-authored-by: Christopher Teubert <christopher.a.teubert@nasa.gov>
1 parent a210bf9 commit 5309a9b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

examples/benchmarking.ipynb

Lines changed: 4 additions & 4 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 how to benchmark the computational efficiency of models with a simple example."
25+
"The goal of this notebook is to demonstrate benchmarking Prognostic Models. Specifically, we will demonstrate how to benchmark the computational efficiency of model simulation. This is typically what you want to look at when benchmarking models, since simulation is the foundation of state estimation and prediction."
2626
]
2727
},
2828
{
@@ -39,7 +39,7 @@
3939
"metadata": {},
4040
"outputs": [],
4141
"source": [
42-
"from prog_models.models import BatteryCircuit\n",
42+
"from progpy.models import BatteryCircuit\n",
4343
"from timeit import timeit"
4444
]
4545
},
@@ -48,15 +48,15 @@
4848
"cell_type": "markdown",
4949
"metadata": {},
5050
"source": [
51-
"The first import is importing ProgPy's BatteryCircuit Model, and the second import will be used to benchmark our model!"
51+
"The first import is importing a model to benchmark. In this case, ProgPy's BatteryCircuit Model. The second import is of the timeit tool, which will be used to benchmark our model."
5252
]
5353
},
5454
{
5555
"attachments": {},
5656
"cell_type": "markdown",
5757
"metadata": {},
5858
"source": [
59-
"Next, let's initialize our Battery Circuit by creating a model object."
59+
"Next, let's create our Battery Circuit model."
6060
]
6161
},
6262
{

0 commit comments

Comments
 (0)