Skip to content

Commit

Permalink
Merge branch 'ipynb-benchmarking' of https://github.com/nasa/progpy i…
Browse files Browse the repository at this point in the history
…nto ipynb-benchmarking
  • Loading branch information
aqitya committed Aug 9, 2023
2 parents 677ac7a + 5309a9b commit bbe3e5b
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions examples/benchmarking.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,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 @@ -30,7 +30,7 @@
"metadata": {},
"outputs": [],
"source": [
"from prog_models.models import BatteryCircuit\n",
"from progpy.models import BatteryCircuit\n",
"from timeit import timeit"
]
},
Expand All @@ -39,15 +39,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 All @@ -65,7 +65,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"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"
"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"
]
},
{
Expand Down Expand Up @@ -94,9 +94,9 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Finally, we are going to need to benchmark the simulation!\n",
"Finally, we are ready to benchmark the simulation.\n",
"\n",
"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"
"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"
]
},
{
Expand All @@ -116,7 +116,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"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."
"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."
]
},
{
Expand Down

0 comments on commit bbe3e5b

Please sign in to comment.