From 6a96ac418953a9a7b5fe16af3ab5e16505635b81 Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Fri, 19 Jul 2024 00:53:02 +0200 Subject: [PATCH 01/11] Adding knapsack-pyoptinterface app --- .../.devcontainer/devcontainer.json | 16 ++ knapsack-pyoptinterface/LICENSE | 201 ++++++++++++++++++ knapsack-pyoptinterface/README.md | 69 ++++++ knapsack-pyoptinterface/VERSION | 1 + knapsack-pyoptinterface/app.yaml | 11 + knapsack-pyoptinterface/input.json | 60 ++++++ .../knapsack-highspy.code-workspace | 27 +++ knapsack-pyoptinterface/main.py | 152 +++++++++++++ knapsack-pyoptinterface/requirements.txt | 5 + 9 files changed, 542 insertions(+) create mode 100644 knapsack-pyoptinterface/.devcontainer/devcontainer.json create mode 100644 knapsack-pyoptinterface/LICENSE create mode 100644 knapsack-pyoptinterface/README.md create mode 100644 knapsack-pyoptinterface/VERSION create mode 100644 knapsack-pyoptinterface/app.yaml create mode 100644 knapsack-pyoptinterface/input.json create mode 100644 knapsack-pyoptinterface/knapsack-highspy.code-workspace create mode 100644 knapsack-pyoptinterface/main.py create mode 100644 knapsack-pyoptinterface/requirements.txt diff --git a/knapsack-pyoptinterface/.devcontainer/devcontainer.json b/knapsack-pyoptinterface/.devcontainer/devcontainer.json new file mode 100644 index 0000000..6e965ed --- /dev/null +++ b/knapsack-pyoptinterface/.devcontainer/devcontainer.json @@ -0,0 +1,16 @@ +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/go +{ + "name": "Python", + // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile + "image": "ghcr.io/nextmv-io/runtime/python:3.11", + "customizations": { + "vscode": { + "extensions": ["ms-python.debugpy", "ms-python.python"], + "settings": { + "python.defaultInterpreterPath": "python" + } + } + }, + "postCreateCommand": "pip install -r requirements.txt" +} diff --git a/knapsack-pyoptinterface/LICENSE b/knapsack-pyoptinterface/LICENSE new file mode 100644 index 0000000..2c27ec7 --- /dev/null +++ b/knapsack-pyoptinterface/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022-2024 nextmv.io inc. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/knapsack-pyoptinterface/README.md b/knapsack-pyoptinterface/README.md new file mode 100644 index 0000000..3e1f1af --- /dev/null +++ b/knapsack-pyoptinterface/README.md @@ -0,0 +1,69 @@ +# Nextmv PyOptInterface Python template + +This template demonstrates how to solve a Mixed Integer Programming problem +using the [highs][highs] solver through the [PyOptInterface][pyoptinterface] + +To solve a Mixed Integer Problem (MIP) is to optimize a linear objective +function of many variables, subject to linear constraints. We demonstrate this +by solving the knapsack problem using the [PyOptInterface][pyoptinterface] MIP +modeling interface. + +Knapsack is a classic combinatorial optimization problem. Given a collection of +items with a value and weight, our objective is to maximize the total value +without exceeding the weight capacity of the knapsack. + +The input defines a number of items which have an id to identify the item, a +weight and a value. Additionally there is a weight capacity. + +The most important files created are `main.py` and `input.json`. + +* `main.py` implements a MIP knapsack solver. +* `input.json` is a sample input file. + +Follow these steps to run locally. + +1. The packages listed in the `requirements.txt` will get bundled with the app + as defined in the `app.yaml` manifest. When working locally, make sure that + these are installed as well: + + ```bash + pip3 install -r requirements.txt + ``` + +1. Run the command below to check that everything works as expected: + + ```bash + python3 main.py -input input.json -output output.json -duration 30 + ``` + +1. A file `output.json` should have been created with the optimal knapsack + solution. + +## Mirror running on Nextmv Cloud locally + +Pre-requisites: Docker needs to be installed. + +To run the application locally in the same docker image as the one used on the +Nextmv Cloud, you can use the following command: + +```bash +cat input.json | docker run -i --rm \ +-v $(pwd):/app ghcr.io/nextmv-io/runtime/python:3.11 \ +sh -c 'pip install -r requirements.txt > /dev/null && python3 /app/main.py' +``` + +You can also debug the application by running it in a Dev Container. This +workspace recommends to install the Dev Container extension for VSCode. If you +have the extension installed, you can open the workspace in a container by using +the command `Dev Containers: Reopen in Container`. + +## Next steps + +* Open `main.py` and read through the comments to understand the model. +* Further documentation, guides, and API references about custom modeling and + deployment can also be found on our [blog](https://www.nextmv.io/blog) and on + our [documentation site](https://docs.nextmv.io). +* Need more assistance? Send us an [email](mailto:support@nextmv.io)! + +[highs]: https://highs.dev/ +[pyoptinterface]: https://github.com/metab0t/PyOptInterface diff --git a/knapsack-pyoptinterface/VERSION b/knapsack-pyoptinterface/VERSION new file mode 100644 index 0000000..45c7a58 --- /dev/null +++ b/knapsack-pyoptinterface/VERSION @@ -0,0 +1 @@ +v0.0.1 diff --git a/knapsack-pyoptinterface/app.yaml b/knapsack-pyoptinterface/app.yaml new file mode 100644 index 0000000..f0de77f --- /dev/null +++ b/knapsack-pyoptinterface/app.yaml @@ -0,0 +1,11 @@ +# This manifest holds the information the app needs to run on the Nextmv Cloud. +type: python +runtime: ghcr.io/nextmv-io/runtime/python:3.11 +# List all files/directories that should be included in the app. Globbing +# (e.g.: configs/*.json) is supported. +files: + - main.py +python: + # Packages the app depends on need to be listed in a requirements.txt file + # that is referenced here. All listed packages will get bundled with the app. + pip-requirements: requirements.txt diff --git a/knapsack-pyoptinterface/input.json b/knapsack-pyoptinterface/input.json new file mode 100644 index 0000000..98eee19 --- /dev/null +++ b/knapsack-pyoptinterface/input.json @@ -0,0 +1,60 @@ +{ + "items": [ + { + "id": "cat", + "value": 100, + "weight": 20 + }, + { + "id": "dog", + "value": 20, + "weight": 45 + }, + { + "id": "water", + "value": 40, + "weight": 2 + }, + { + "id": "phone", + "value": 6, + "weight": 1 + }, + { + "id": "book", + "value": 63, + "weight": 10 + }, + { + "id": "rx", + "value": 81, + "weight": 1 + }, + { + "id": "tablet", + "value": 28, + "weight": 8 + }, + { + "id": "coat", + "value": 44, + "weight": 9 + }, + { + "id": "laptop", + "value": 51, + "weight": 13 + }, + { + "id": "keys", + "value": 92, + "weight": 1 + }, + { + "id": "nuts", + "value": 18, + "weight": 4 + } + ], + "weight_capacity": 50 +} diff --git a/knapsack-pyoptinterface/knapsack-highspy.code-workspace b/knapsack-pyoptinterface/knapsack-highspy.code-workspace new file mode 100644 index 0000000..3fd4af0 --- /dev/null +++ b/knapsack-pyoptinterface/knapsack-highspy.code-workspace @@ -0,0 +1,27 @@ +{ + "folders": [{ + "path": "." + }], + "launch": { + "configurations": [{ + "name": "Python: Module", + "type": "debugpy", + "request": "launch", + "module": "main", + "justMyCode": true, + "args": [ + "-input", + "input.json", + "-output", + "output.json", + "-duration", + "5" + ] + }] + }, + "extensions": { + "recommendations": [ + "ms-vscode-remote.remote-containers", + ] + } +} diff --git a/knapsack-pyoptinterface/main.py b/knapsack-pyoptinterface/main.py new file mode 100644 index 0000000..83b93c5 --- /dev/null +++ b/knapsack-pyoptinterface/main.py @@ -0,0 +1,152 @@ +""" +Template for working with the pyoptinterface library. +""" + +import argparse +import json +import sys +import time +from importlib.metadata import version +from typing import Any + +import pyoptinterface as poi +from pyoptinterface import highs + + +def main() -> None: + """Entry point for the template.""" + + parser = argparse.ArgumentParser(description="Solve problems with the pyoptinterface library.") + parser.add_argument( + "-input", + default="", + help="Path to input file. Default is stdin.", + ) + parser.add_argument( + "-output", + default="", + help="Path to output file. Default is stdout.", + ) + parser.add_argument( + "-duration", + default=30, + help="Max runtime duration (in seconds). Default is 30.", + type=int, + ) + args = parser.parse_args() + + # Read input data, solve the problem and write the solution. + input_data = read_input(args.input) + + log("Solving knapsack problem:") + log(f" - items: {len(input_data.get('items', []))}") + log(f" - capacity: {input_data.get('weight_capacity', 0)}") + log(f" - max duration: {args.duration} seconds") + + solution = solve(input_data, args.duration) + write_output(args.output, solution) + + +def solve(input_data: dict[str, Any], duration: int) -> dict[str, Any]: + """Solves the given problem and returns the solution.""" + + start = time.time() + + # Creates the solver. + model = highs.Model() + + # Initializes the linear sums. + weights = 0.0 + values = 0.0 + + # Creates the decision variables and adds them to the linear sums. + items = [] + for item in input_data["items"]: + item_variable = model.add_variable( + lb=0.0, + ub=1.0, + domain=poi.VariableDomain.Integer, + name=item["id"], + ) + items.append({"item": item, "variable": item_variable}) + weights += item_variable * item["weight"] + values += item_variable * item["value"] + + # This constraint ensures the weight capacity of the knapsack will not be + # exceeded. + model.add_linear_constraint( + expr=weights, + sense=poi.ConstraintSense.LessEqual, + rhs=input_data["weight_capacity"], + name="weight_capacity", + ) + + # Sets the objective function: maximize the value of the chosen items. + status = model.set_objective( + expr=values, + sense=poi.ObjectiveSense.Maximize, + ) + + # Solves the problem. + model.optimize() + status = model.get_model_attribute(poi.ModelAttribute.TerminationStatus) + + # Determines which items were chosen. + chosen_items = [item["item"] for item in items if model.get_value(item["variable"]) > 0.9] + + # Creates the statistics. + statistics = { + "result": { + "custom": { + "constraints": model.number_of_constraints(type=poi.ConstraintType.Linear), + "variables": model.number_of_variables(), + "status": str(status), + }, + "value": sum(item["value"] for item in chosen_items), + }, + "run": { + "duration": time.time() - start, + "version": version("pyoptinterface"), + }, + "schema": "v1", + } + + return { + "solutions": [{"items": chosen_items}], + "statistics": statistics, + } + + +def log(message: str) -> None: + """Logs a message. We need to use stderr since stdout is used for the + solution.""" + + print(message, file=sys.stderr) + + +def read_input(input_path: str) -> dict[str, Any]: + """Reads the input from stdin or a given input file.""" + + input_file = {} + if input_path: + with open(input_path, encoding="utf-8") as file: + input_file = json.load(file) + else: + input_file = json.load(sys.stdin) + + return input_file + + +def write_output(output_path: str, output: dict[str, Any]) -> None: + """Writes the output to stdout or a given output file.""" + + content = json.dumps(output, indent=2) + if output_path: + with open(output_path, "w", encoding="utf-8") as file: + file.write(content + "\n") + else: + print(content) + + +if __name__ == "__main__": + main() diff --git a/knapsack-pyoptinterface/requirements.txt b/knapsack-pyoptinterface/requirements.txt new file mode 100644 index 0000000..fd9e163 --- /dev/null +++ b/knapsack-pyoptinterface/requirements.txt @@ -0,0 +1,5 @@ +# pyoptinterface package with the Highs solver. +pyoptinterface[highs]==0.2.6 + +# Other packages. +nextmv==0.9.0 From 03792073d58842a7fb1c05c82c578a5f6291def7 Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Fri, 19 Jul 2024 01:00:05 +0200 Subject: [PATCH 02/11] Adding tests, adhere to timelimit, silence output --- .../knapsack-pyoptinterface/inputs/input.json | 60 ++++++++++++++++++ .../inputs/input.json.golden | 63 +++++++++++++++++++ .../knapsack-pyoptinterface/main_test.go | 42 +++++++++++++ .nextmv/readme/knapsack-pyoptinterface/0.sh | 1 + .../knapsack-pyoptinterface/0.sh.golden | 0 .nextmv/readme/knapsack-pyoptinterface/1.sh | 1 + .../knapsack-pyoptinterface/1.sh.golden | 0 .nextmv/readme/knapsack-pyoptinterface/2.sh | 3 + .nextmv/readme/workflow-configuration.yml | 6 ++ knapsack-pyoptinterface/main.py | 2 + 10 files changed, 178 insertions(+) create mode 100644 .nextmv/golden/knapsack-pyoptinterface/inputs/input.json create mode 100644 .nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden create mode 100644 .nextmv/golden/knapsack-pyoptinterface/main_test.go create mode 100644 .nextmv/readme/knapsack-pyoptinterface/0.sh create mode 100644 .nextmv/readme/knapsack-pyoptinterface/0.sh.golden create mode 100644 .nextmv/readme/knapsack-pyoptinterface/1.sh create mode 100644 .nextmv/readme/knapsack-pyoptinterface/1.sh.golden create mode 100644 .nextmv/readme/knapsack-pyoptinterface/2.sh diff --git a/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json new file mode 100644 index 0000000..98eee19 --- /dev/null +++ b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json @@ -0,0 +1,60 @@ +{ + "items": [ + { + "id": "cat", + "value": 100, + "weight": 20 + }, + { + "id": "dog", + "value": 20, + "weight": 45 + }, + { + "id": "water", + "value": 40, + "weight": 2 + }, + { + "id": "phone", + "value": 6, + "weight": 1 + }, + { + "id": "book", + "value": 63, + "weight": 10 + }, + { + "id": "rx", + "value": 81, + "weight": 1 + }, + { + "id": "tablet", + "value": 28, + "weight": 8 + }, + { + "id": "coat", + "value": 44, + "weight": 9 + }, + { + "id": "laptop", + "value": 51, + "weight": 13 + }, + { + "id": "keys", + "value": 92, + "weight": 1 + }, + { + "id": "nuts", + "value": 18, + "weight": 4 + } + ], + "weight_capacity": 50 +} diff --git a/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden new file mode 100644 index 0000000..fba5688 --- /dev/null +++ b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden @@ -0,0 +1,63 @@ +{ + "solutions": [ + { + "items": [ + { + "id": "cat", + "value": 100, + "weight": 20 + }, + { + "id": "water", + "value": 40, + "weight": 2 + }, + { + "id": "phone", + "value": 6, + "weight": 1 + }, + { + "id": "book", + "value": 63, + "weight": 10 + }, + { + "id": "rx", + "value": 81, + "weight": 1 + }, + { + "id": "coat", + "value": 44, + "weight": 9 + }, + { + "id": "keys", + "value": 92, + "weight": 1 + }, + { + "id": "nuts", + "value": 18, + "weight": 4 + } + ] + } + ], + "statistics": { + "result": { + "custom": { + "constraints": 1, + "status": "TerminationStatusCode.OPTIMAL", + "variables": 11 + }, + "value": 444 + }, + "run": { + "duration": 0.123, + "version": "0.2.6" + }, + "schema": "v1" + } +} diff --git a/.nextmv/golden/knapsack-pyoptinterface/main_test.go b/.nextmv/golden/knapsack-pyoptinterface/main_test.go new file mode 100644 index 0000000..c643028 --- /dev/null +++ b/.nextmv/golden/knapsack-pyoptinterface/main_test.go @@ -0,0 +1,42 @@ +package mip + +import ( + "os" + "testing" + + "github.com/nextmv-io/sdk/golden" +) + +func TestMain(m *testing.M) { + code := m.Run() + os.Exit(code) +} + +func TestGolden(t *testing.T) { + golden.FileTests( + t, + "inputs", + golden.Config{ + Args: []string{ + "-duration", + "30", + }, + TransientFields: []golden.TransientField{ + { + Key: ".statistics.result.duration", + Replacement: golden.StableFloat, + }, + { + Key: ".statistics.run.duration", + Replacement: golden.StableFloat, + }, + }, + ExecutionConfig: &golden.ExecutionConfig{ + Command: "python3", + Args: []string{"../../../knapsack-pyoptinterface/main.py"}, + InputFlag: "-input", + OutputFlag: "-output", + }, + }, + ) +} diff --git a/.nextmv/readme/knapsack-pyoptinterface/0.sh b/.nextmv/readme/knapsack-pyoptinterface/0.sh new file mode 100644 index 0000000..bc88b5d --- /dev/null +++ b/.nextmv/readme/knapsack-pyoptinterface/0.sh @@ -0,0 +1 @@ +pip3 install -r requirements.txt diff --git a/.nextmv/readme/knapsack-pyoptinterface/0.sh.golden b/.nextmv/readme/knapsack-pyoptinterface/0.sh.golden new file mode 100644 index 0000000..e69de29 diff --git a/.nextmv/readme/knapsack-pyoptinterface/1.sh b/.nextmv/readme/knapsack-pyoptinterface/1.sh new file mode 100644 index 0000000..da4a9a0 --- /dev/null +++ b/.nextmv/readme/knapsack-pyoptinterface/1.sh @@ -0,0 +1 @@ +python3 main.py -input input.json -output output.json -duration 30 diff --git a/.nextmv/readme/knapsack-pyoptinterface/1.sh.golden b/.nextmv/readme/knapsack-pyoptinterface/1.sh.golden new file mode 100644 index 0000000..e69de29 diff --git a/.nextmv/readme/knapsack-pyoptinterface/2.sh b/.nextmv/readme/knapsack-pyoptinterface/2.sh new file mode 100644 index 0000000..53526d3 --- /dev/null +++ b/.nextmv/readme/knapsack-pyoptinterface/2.sh @@ -0,0 +1,3 @@ +cat input.json | docker run -i --rm \ +-v $(pwd):/app ghcr.io/nextmv-io/runtime/python:3.11 \ +sh -c 'pip install -r requirements.txt > /dev/null && python3 /app/main.py' diff --git a/.nextmv/readme/workflow-configuration.yml b/.nextmv/readme/workflow-configuration.yml index 8bc3c9c..80a32ae 100644 --- a/.nextmv/readme/workflow-configuration.yml +++ b/.nextmv/readme/workflow-configuration.yml @@ -53,6 +53,12 @@ apps: silent: true - name: 2.sh skip: true + - name: knapsack-pyoptinterface + scripts: + - name: 0.sh + silent: true + - name: 2.sh + skip: true - name: nextroute scripts: - name: 0.sh diff --git a/knapsack-pyoptinterface/main.py b/knapsack-pyoptinterface/main.py index 83b93c5..da8893f 100644 --- a/knapsack-pyoptinterface/main.py +++ b/knapsack-pyoptinterface/main.py @@ -54,6 +54,8 @@ def solve(input_data: dict[str, Any], duration: int) -> dict[str, Any]: # Creates the solver. model = highs.Model() + model.set_model_attribute(poi.ModelAttribute.TimeLimitSec, duration) + model.set_model_attribute(poi.ModelAttribute.Silent, True) # Initializes the linear sums. weights = 0.0 From a9bca918bf77e0b442d303360bc60785f155b17a Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Mon, 9 Sep 2024 23:37:03 +0200 Subject: [PATCH 03/11] Fix workspace name --- ...hspy.code-workspace => knapsack-pyoptinterface.code-workspace} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename knapsack-pyoptinterface/{knapsack-highspy.code-workspace => knapsack-pyoptinterface.code-workspace} (100%) diff --git a/knapsack-pyoptinterface/knapsack-highspy.code-workspace b/knapsack-pyoptinterface/knapsack-pyoptinterface.code-workspace similarity index 100% rename from knapsack-pyoptinterface/knapsack-highspy.code-workspace rename to knapsack-pyoptinterface/knapsack-pyoptinterface.code-workspace From d29747b8471b62fad8a753fb8eca89c7e17504ba Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Mon, 9 Sep 2024 23:42:52 +0200 Subject: [PATCH 04/11] Using new python app style --- knapsack-pyoptinterface/main.py | 108 +++++++++----------------------- 1 file changed, 29 insertions(+), 79 deletions(-) diff --git a/knapsack-pyoptinterface/main.py b/knapsack-pyoptinterface/main.py index da8893f..9fb2c2b 100644 --- a/knapsack-pyoptinterface/main.py +++ b/knapsack-pyoptinterface/main.py @@ -2,13 +2,10 @@ Template for working with the pyoptinterface library. """ -import argparse -import json -import sys import time from importlib.metadata import version -from typing import Any +import nextmv import pyoptinterface as poi from pyoptinterface import highs @@ -16,45 +13,30 @@ def main() -> None: """Entry point for the template.""" - parser = argparse.ArgumentParser(description="Solve problems with the pyoptinterface library.") - parser.add_argument( - "-input", - default="", - help="Path to input file. Default is stdin.", + options = nextmv.Options( + nextmv.Parameter("input", str, "", "Path to input file. Default is stdin.", False), + nextmv.Parameter("output", str, "", "Path to output file. Default is stdout.", False), + nextmv.Parameter("duration", int, 30, "Max runtime duration (in seconds).", False), ) - parser.add_argument( - "-output", - default="", - help="Path to output file. Default is stdout.", - ) - parser.add_argument( - "-duration", - default=30, - help="Max runtime duration (in seconds). Default is 30.", - type=int, - ) - args = parser.parse_args() - # Read input data, solve the problem and write the solution. - input_data = read_input(args.input) + input = nextmv.load_local(options=options, path=options.input) - log("Solving knapsack problem:") - log(f" - items: {len(input_data.get('items', []))}") - log(f" - capacity: {input_data.get('weight_capacity', 0)}") - log(f" - max duration: {args.duration} seconds") + nextmv.log("Solving knapsack problem:") + nextmv.log(f" - items: {len(input.data.get('items', []))}") + nextmv.log(f" - capacity: {input.data.get('weight_capacity', 0)}") - solution = solve(input_data, args.duration) - write_output(args.output, solution) + output = solve(input, options) + nextmv.write_local(output, path=options.output) -def solve(input_data: dict[str, Any], duration: int) -> dict[str, Any]: +def solve(input_data: nextmv.Input, options: nextmv.Options) -> nextmv.Output: """Solves the given problem and returns the solution.""" start = time.time() # Creates the solver. model = highs.Model() - model.set_model_attribute(poi.ModelAttribute.TimeLimitSec, duration) + model.set_model_attribute(poi.ModelAttribute.TimeLimitSec, options.duration) model.set_model_attribute(poi.ModelAttribute.Silent, True) # Initializes the linear sums. @@ -96,58 +78,26 @@ def solve(input_data: dict[str, Any], duration: int) -> dict[str, Any]: # Determines which items were chosen. chosen_items = [item["item"] for item in items if model.get_value(item["variable"]) > 0.9] + options.version = version("pyoptinterface") + # Creates the statistics. - statistics = { - "result": { - "custom": { - "constraints": model.number_of_constraints(type=poi.ConstraintType.Linear), - "variables": model.number_of_variables(), + statistics = nextmv.Statistics( + run=nextmv.RunStatistics(duration=time.time() - start), + result=nextmv.ResultStatistics( + value=sum(item["value"] for item in chosen_items), + custom={ "status": str(status), + "variables": model.number_of_variables(), + "constraints": model.number_of_constraints(type=poi.ConstraintType.Linear), }, - "value": sum(item["value"] for item in chosen_items), - }, - "run": { - "duration": time.time() - start, - "version": version("pyoptinterface"), - }, - "schema": "v1", - } - - return { - "solutions": [{"items": chosen_items}], - "statistics": statistics, - } - - -def log(message: str) -> None: - """Logs a message. We need to use stderr since stdout is used for the - solution.""" - - print(message, file=sys.stderr) - - -def read_input(input_path: str) -> dict[str, Any]: - """Reads the input from stdin or a given input file.""" - - input_file = {} - if input_path: - with open(input_path, encoding="utf-8") as file: - input_file = json.load(file) - else: - input_file = json.load(sys.stdin) - - return input_file - - -def write_output(output_path: str, output: dict[str, Any]) -> None: - """Writes the output to stdout or a given output file.""" + ), + ) - content = json.dumps(output, indent=2) - if output_path: - with open(output_path, "w", encoding="utf-8") as file: - file.write(content + "\n") - else: - print(content) + return nextmv.Output( + options=options, + solution={"items": chosen_items}, + statistics=statistics, + ) if __name__ == "__main__": From 3d09f44143e154021db0ea783e792ac3832025c5 Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Mon, 9 Sep 2024 23:43:59 +0200 Subject: [PATCH 05/11] Fix input data handling --- knapsack-pyoptinterface/main.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/knapsack-pyoptinterface/main.py b/knapsack-pyoptinterface/main.py index 9fb2c2b..09e4aca 100644 --- a/knapsack-pyoptinterface/main.py +++ b/knapsack-pyoptinterface/main.py @@ -29,7 +29,7 @@ def main() -> None: nextmv.write_local(output, path=options.output) -def solve(input_data: nextmv.Input, options: nextmv.Options) -> nextmv.Output: +def solve(input: nextmv.Input, options: nextmv.Options) -> nextmv.Output: """Solves the given problem and returns the solution.""" start = time.time() @@ -45,7 +45,7 @@ def solve(input_data: nextmv.Input, options: nextmv.Options) -> nextmv.Output: # Creates the decision variables and adds them to the linear sums. items = [] - for item in input_data["items"]: + for item in input.data["items"]: item_variable = model.add_variable( lb=0.0, ub=1.0, @@ -61,7 +61,7 @@ def solve(input_data: nextmv.Input, options: nextmv.Options) -> nextmv.Output: model.add_linear_constraint( expr=weights, sense=poi.ConstraintSense.LessEqual, - rhs=input_data["weight_capacity"], + rhs=input.data["weight_capacity"], name="weight_capacity", ) From 2d3a396f854304f25e1d3fdd4d9186b4acf386ce Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Tue, 10 Sep 2024 11:48:19 +0200 Subject: [PATCH 06/11] Use custom pyoptinterface until full support --- knapsack-pyoptinterface/requirements.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/knapsack-pyoptinterface/requirements.txt b/knapsack-pyoptinterface/requirements.txt index fd9e163..25575c0 100644 --- a/knapsack-pyoptinterface/requirements.txt +++ b/knapsack-pyoptinterface/requirements.txt @@ -1,5 +1,7 @@ # pyoptinterface package with the Highs solver. -pyoptinterface[highs]==0.2.6 +# Note: until linux/aarch64 wheels are available on PyPI, the wheel is hosted independently on GitHub. +highsbox==1.7.2.post2 +https://merschformann.github.io/random/content/wheels/pyoptinterface/pyoptinterface-0.2.8-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl # Other packages. -nextmv==0.9.0 +nextmv==v0.10.0.dev13 From c89018a71fdb1b01176a3cbd7638954191b16cef Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Tue, 10 Sep 2024 11:52:41 +0200 Subject: [PATCH 07/11] Adding separate requirements file for push --- knapsack-pyoptinterface/app.yaml | 2 +- knapsack-pyoptinterface/requirements-arm64.txt | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 knapsack-pyoptinterface/requirements-arm64.txt diff --git a/knapsack-pyoptinterface/app.yaml b/knapsack-pyoptinterface/app.yaml index f0de77f..caa761c 100644 --- a/knapsack-pyoptinterface/app.yaml +++ b/knapsack-pyoptinterface/app.yaml @@ -8,4 +8,4 @@ files: python: # Packages the app depends on need to be listed in a requirements.txt file # that is referenced here. All listed packages will get bundled with the app. - pip-requirements: requirements.txt + pip-requirements: requirements-arm64.txt diff --git a/knapsack-pyoptinterface/requirements-arm64.txt b/knapsack-pyoptinterface/requirements-arm64.txt new file mode 100644 index 0000000..9569cfc --- /dev/null +++ b/knapsack-pyoptinterface/requirements-arm64.txt @@ -0,0 +1,7 @@ +# pyoptinterface package with the Highs solver. +# Note: until linux/aarch64 wheels are available on PyPI, the necessary wheel is hosted independently on GitHub. +highsbox==1.7.2.post2 +https://merschformann.github.io/random/content/wheels/pyoptinterface/pyoptinterface-0.2.8-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl + +# Other packages. +nextmv==v0.10.0.dev13 From 9348da9bc41f13b75036d4af9dfd692a1cfc0600 Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Tue, 10 Sep 2024 11:58:34 +0200 Subject: [PATCH 08/11] Fix x64 dependency --- knapsack-pyoptinterface/requirements.txt | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/knapsack-pyoptinterface/requirements.txt b/knapsack-pyoptinterface/requirements.txt index 25575c0..1158efc 100644 --- a/knapsack-pyoptinterface/requirements.txt +++ b/knapsack-pyoptinterface/requirements.txt @@ -1,7 +1,5 @@ # pyoptinterface package with the Highs solver. -# Note: until linux/aarch64 wheels are available on PyPI, the wheel is hosted independently on GitHub. -highsbox==1.7.2.post2 -https://merschformann.github.io/random/content/wheels/pyoptinterface/pyoptinterface-0.2.8-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl +pyoptinterface[highs]==0.2.8 # Other packages. nextmv==v0.10.0.dev13 From 6017e0627d0fdd3bb6fe87ed7e728fa83bf3420b Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Tue, 10 Sep 2024 23:27:33 +0200 Subject: [PATCH 09/11] Fix pyoptinterface golden file test --- .../inputs/input.json.golden | 99 ++++++++++--------- .../knapsack-pyoptinterface/main_test.go | 12 ++- .nextmv/golden/workflow-configuration.yml | 3 + 3 files changed, 64 insertions(+), 50 deletions(-) diff --git a/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden index fba5688..c421586 100644 --- a/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden +++ b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden @@ -1,50 +1,54 @@ { - "solutions": [ - { - "items": [ - { - "id": "cat", - "value": 100, - "weight": 20 - }, - { - "id": "water", - "value": 40, - "weight": 2 - }, - { - "id": "phone", - "value": 6, - "weight": 1 - }, - { - "id": "book", - "value": 63, - "weight": 10 - }, - { - "id": "rx", - "value": 81, - "weight": 1 - }, - { - "id": "coat", - "value": 44, - "weight": 9 - }, - { - "id": "keys", - "value": 92, - "weight": 1 - }, - { - "id": "nuts", - "value": 18, - "weight": 4 - } - ] - } - ], + "options": { + "duration": 30, + "input": "input.json", + "output": "output.json", + "version": "0.2.6" + }, + "solution": { + "items": [ + { + "id": "cat", + "value": 100, + "weight": 20 + }, + { + "id": "water", + "value": 40, + "weight": 2 + }, + { + "id": "phone", + "value": 6, + "weight": 1 + }, + { + "id": "book", + "value": 63, + "weight": 10 + }, + { + "id": "rx", + "value": 81, + "weight": 1 + }, + { + "id": "coat", + "value": 44, + "weight": 9 + }, + { + "id": "keys", + "value": 92, + "weight": 1 + }, + { + "id": "nuts", + "value": 18, + "weight": 4 + } + ] + }, "statistics": { "result": { "custom": { @@ -55,8 +59,7 @@ "value": 444 }, "run": { - "duration": 0.123, - "version": "0.2.6" + "duration": 0.123 }, "schema": "v1" } diff --git a/.nextmv/golden/knapsack-pyoptinterface/main_test.go b/.nextmv/golden/knapsack-pyoptinterface/main_test.go index c643028..4216d56 100644 --- a/.nextmv/golden/knapsack-pyoptinterface/main_test.go +++ b/.nextmv/golden/knapsack-pyoptinterface/main_test.go @@ -23,13 +23,21 @@ func TestGolden(t *testing.T) { }, TransientFields: []golden.TransientField{ { - Key: ".statistics.result.duration", + Key: "$.statistics.result.duration", Replacement: golden.StableFloat, }, { - Key: ".statistics.run.duration", + Key: "$.statistics.run.duration", Replacement: golden.StableFloat, }, + { + Key: "$.options.output", + Replacement: "output.json", + }, + { + Key: "$.options.input", + Replacement: "input.json", + }, }, ExecutionConfig: &golden.ExecutionConfig{ Command: "python3", diff --git a/.nextmv/golden/workflow-configuration.yml b/.nextmv/golden/workflow-configuration.yml index b9d7d4c..70296da 100644 --- a/.nextmv/golden/workflow-configuration.yml +++ b/.nextmv/golden/workflow-configuration.yml @@ -26,6 +26,9 @@ apps: - name: knapsack-pyomo language: python language-version: 3.11 + - name: knapsack-pyoptinterface + language: python + language-version: 3.11 - name: hello-world language: python language-version: 3.11 From fa1df45e191c89d216e09d3c1439c6bfb9a896aa Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Tue, 10 Sep 2024 23:42:58 +0200 Subject: [PATCH 10/11] Upgrade expectation --- .nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden index c421586..2f19601 100644 --- a/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden +++ b/.nextmv/golden/knapsack-pyoptinterface/inputs/input.json.golden @@ -3,7 +3,7 @@ "duration": 30, "input": "input.json", "output": "output.json", - "version": "0.2.6" + "version": "0.2.8" }, "solution": { "items": [ From a1d15ccdb7cb476c85c79957d72f48c125224d41 Mon Sep 17 00:00:00 2001 From: Marius Merschformann Date: Tue, 10 Sep 2024 23:49:47 +0200 Subject: [PATCH 11/11] Add pyoptinterface app to workflow config --- .nextmv/workflow-configuration.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.nextmv/workflow-configuration.yml b/.nextmv/workflow-configuration.yml index 05e265b..c323408 100644 --- a/.nextmv/workflow-configuration.yml +++ b/.nextmv/workflow-configuration.yml @@ -48,6 +48,11 @@ apps: app_id: knapsack-pyomo marketplace_app_id: knapsack.pyomo description: Solve a knapsack problem using Pyomo. + - name: knapsack-pyoptinterface + type: python + app_id: + marketplace_app_id: + description: Solve a knapsack problem using PyOptInterface. - name: hello-world type: python app_id: