Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Christopher Teubert <christopher.a.teubert@nasa.gov>
  • Loading branch information
aqitya and teubert committed Aug 9, 2023
1 parent a210bf9 commit 5309a9b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions examples/benchmarking.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"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."
"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."
]
},
{
Expand All @@ -39,7 +39,7 @@
"metadata": {},
"outputs": [],
"source": [
"from prog_models.models import BatteryCircuit\n",
"from progpy.models import BatteryCircuit\n",
"from timeit import timeit"
]
},
Expand All @@ -48,15 +48,15 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The first import is importing ProgPy's BatteryCircuit Model, and the second import will be used to benchmark our model!"
"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."
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"Next, let's initialize our Battery Circuit by creating a model object."
"Next, let's create our Battery Circuit model."
]
},
{
Expand Down

0 comments on commit 5309a9b

Please sign in to comment.