summaryrefslogtreecommitdiffstats
path: root/extra_info.md
diff options
context:
space:
mode:
authorAndrea Censi <AndreaCensi@users.noreply.github.com>2023-12-10 20:54:59 +0100
committerAndrea Censi <AndreaCensi@users.noreply.github.com>2023-12-10 20:54:59 +0100
commit4d037a64e1973b1ae177ed80b7a613292e0e5a4d (patch)
treecc7141748b2815ba8f82a8fc2fb0222bae867eef /extra_info.md
parentMerge pull request #4 from ACT4E/YH-ReadMe-1706 (diff)
downloadact4e-mcdp-4d037a64e1973b1ae177ed80b7a613292e0e5a4d.tar.gz
act4e-mcdp-4d037a64e1973b1ae177ed80b7a613292e0e5a4d.zip
fall2023
Diffstat (limited to 'extra_info.md')
-rw-r--r--extra_info.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/extra_info.md b/extra_info.md
new file mode 100644
index 0000000..2b2fb69
--- /dev/null
+++ b/extra_info.md
@@ -0,0 +1,71 @@
+# Extra information
+
+### Running the DP solver for a specific model and query
+
+`act4e-mcdp-solve-dp` is the command you use to run the DP solver
+for a particular model and query:
+
+ act4e-mcdp-solve-dp \
+ --solver act4e_mcdp_solution.DPSolver \
+ --query FixFunMinRes \
+ --model downloaded/lib1-parts/lib1-parts.primitivedps.e03_splitter1.mcdpr1.yaml \
+ --data '10'
+
+In brief:
+
+* `--solver act4e_mcdp_solution.DPSolver`: this selects the class for your solver;
+* `--query FixFunMinRes`: this selects `FixFunMinRes` (other choice: `FixResMaxFun`);
+* `--model downloaded/lib1-parts/lib1-parts.primitivedps.e03_splitter1.mcdpr1.yaml`: this selects the model to use for optimization;
+* `--data '10'`: this selects the query to give.
+
+You will see the result in the logs:
+
+```
+INFO query: 10
+INFO solution: Interval(pessimistic=UpperSet(minima=[]), optimistic=UpperSet(minima=[]))
+```
+
+The template `act4e_mcdp_solution.MySolution` always returns an empty `UpperSet` (= infeasible).
+
+
+
+# Creating more test cases
+
+The models are created using [this online environment][IDE] - very experimental!
+
+[IDE]: https://editor.zuper.ai/editor/gh/co-design-models/ACT4E-exercises-spring2023/main/view/
+
+If you make an account you can play around. You can obtain the YAML file read by `ACT4E-mcdp` by selecting the "DP compiled YAML representation" option from the drop down menu. Some of the other visualizations might also be helpful.
+
+[Example: drone model](https://editor.zuper.ai/editor/gh/co-design-models/ACT4E-exercises-spring2023/main/view/libraries/lib2-simple/specs/models/things/drone1/)
+
+ <img width="1113" alt="mcdpdrone" src="https://github.com/ACT4E/ACT4E-mcdp-exercise-template/assets/81052/b2e3c9ec-c55c-49c8-9e0c-071c02fb03c0">
+
+
+
+<!--
+
+### Running the MCDP solver
+
+This is the command you use to run the MCDP solver:
+
+ act4e-mcdp-solve-mcdp \
+ --solver act4e_mcdp_solution.MCDPSolver \
+ --query FixFunMinRes \
+ --model downloaded/lib1-parts.models.e03_splitter1.mcdpr1.yaml \
+ --data '{f: 42}'
+
+Note that for the MCDP solver we give a file of type `models.mcdpr1.yaml` instead of `primitivedps.mcdpr1.yaml`.
+
+For the data, we use a key-value pair with the functionality name and the value.
+
+You should see the output:
+
+ query: {'f': Decimal('42')}
+ solution: Interval(pessimistic=UpperSet(minima=[]), optimistic=UpperSet(minima=[]))
+
+## Running the MCDP solver on a set of test cases
+
+TODO: finish this part
+
+--->