From 98ae4d3ad46da274213bd64dee44492c5fca7650 Mon Sep 17 00:00:00 2001 From: Alinson S Xavier Date: Wed, 2 Jun 2021 09:36:32 -0500 Subject: [PATCH] Update docs --- docs/usage.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index a7b87ff..d5a64d5 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -71,7 +71,7 @@ Advanced usage ### Customizing the formulation -By default, `build_model` uses a formulation that combines modeling components from different publications, and that has been carefully tested, using our own benchmark scripts, to provide good performance across a wide variety of instances. This default formulation is expected to change over time, as new methods are proposed in the literature. You can, however, construct your own formulation, based the modeling components that you choose, as shown in the next example. +By default, `build_model` uses a formulation that combines modeling components from different publications, and that has been carefully tested, using our own benchmark scripts, to provide good performance across a wide variety of instances. This default formulation is expected to change over time, as new methods are proposed in the literature. You can, however, construct your own formulation, based on the modeling components that you choose, as shown in the next example. ```julia using Cbc @@ -119,7 +119,10 @@ instance = UnitCommitment.read("instance.json") UnitCommitment.generate_initial_conditions!(instance, Cbc.Optimizer) # Construct and solve optimization model -model = UnitCommitment.build_model(instance, Cbc.Optimizer) +model = UnitCommitment.build_model( + instance=instance, + optimizer=Cbc.Optimizer, +) UnitCommitment.optimize!(model) ```