From 5309a9b843914e4d6854ab08ebefbfd84feab6d5 Mon Sep 17 00:00:00 2001 From: aqitya <98992627+aqitya@users.noreply.github.com> Date: Wed, 9 Aug 2023 11:45:24 -0700 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Christopher Teubert --- examples/benchmarking.ipynb | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/benchmarking.ipynb b/examples/benchmarking.ipynb index 5b921cd..b22fb9d 100644 --- a/examples/benchmarking.ipynb +++ b/examples/benchmarking.ipynb @@ -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." ] }, { @@ -39,7 +39,7 @@ "metadata": {}, "outputs": [], "source": [ - "from prog_models.models import BatteryCircuit\n", + "from progpy.models import BatteryCircuit\n", "from timeit import timeit" ] }, @@ -48,7 +48,7 @@ "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." ] }, { @@ -56,7 +56,7 @@ "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." ] }, {