moospread 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

moospread-0.1.1.dist-info/METADATA

@@ -0,0 +1,141 @@
+Metadata-Version: 2.4
+Name: moospread
+Version: 0.1.1
+Summary: Sampling-based Pareto front Refinement via Efficient Adaptive Diffusion
+Author-email: Sedjro Salomon Hotegni <salomon.hotegni@aims.ac.rw>
+Maintainer-email: Sedjro Salomon Hotegni <salomon.hotegni@tu-dortmund.de>
+License: MIT License
+        
+        Copyright (c) 2026 Sedjro Salomon Hotegni
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+Project-URL: bugs, https://github.com/safe-autonomous-systems/moo-spread/issues
+Project-URL: changelog, https://github.com/safe-autonomous-systems/moo-spread/blob/main/changelog.md
+Project-URL: Homepage, https://github.com/safe-autonomous-systems/moo-spread
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: torch
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://github.com/safe-autonomous-systems/moo-spread/raw/main/images/logo_well_spread.png" 
+       alt="moospread logo" width="300">
+</p>
+<!--
+<p align="center">
+<a href="https://pypi.org/project/moospread/"><img src="https://img.shields.io/pypi/v/advermorel.svg" alt="PyPI version"></a>
+</p>
+-->
+
+# SPREAD: Sampling-based Pareto front Refinement via Efficient Adaptive Diffusion
+
+> SPREAD is a novel sampling-based approach for multi-objective optimization that leverages diffusion models to efficiently refine and generate well-spread Pareto front approximations. It combines the expressiveness of diffusion models with multi-objective optimization principles to achieve both high convergence to the Pareto front and excellent diversity across the objective space. SPREAD demonstrates competitive performance against state-of-the-art methods while providing a flexible framework for different optimization contexts.
+
+## 🚀 Getting Started
+
+### Installation
+
+```python
+conda create -n moospread python=3.11
+conda activate moospread
+pip install moospread
+# To install CUDA‐enabled PyTorch, run (or visit: https://pytorch.org/get-started/locally/):
+pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
+```
+Or, to install the latest code from GitHub:
+```python
+conda create -n moospread python=3.11
+conda activate moospread
+git clone https://github.com/safe-autonomous-systems/moo-spread.git
+cd moo-spread
+pip install -e .
+# To install CUDA‐enabled PyTorch, run (or visit: https://pytorch.org/get-started/locally/):
+pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cu118
+```
+### Basic usage
+This example shows how to solve a standard multi-objective optimization benchmark (ZDT2) using the **SPREAD** solver.
+
+```python
+import numpy as np
+import torch
+
+# Import the SPREAD solver
+from moospread import SPREAD
+
+# Import a test problem
+from moospread.tasks import ZDT2
+
+# Define the problem
+n_var = 30
+problem = ZDT2(n_var=n_var)
+
+# Initialize the SPREAD solver
+solver = SPREAD(
+    problem,
+    data_size=10000,
+    timesteps=5000,
+    num_epochs=1000,
+    train_tol=100,
+    num_blocks=3,
+    validation_split=0.1,
+    mode="online",
+    seed=2026,
+    verbose=True
+)
+
+# Solve the problem
+results = solver.solve(
+    num_points_sample=200,
+    strict_guidance=False,
+    rho_scale_gamma=0.9,
+    nu_t=10.0,
+    eta_init=0.9,
+    num_inner_steps=10,
+    lr_inner=0.9,
+    free_initial_h=True,
+    use_sigma_rep=False,
+    kernel_sigma_rep=0.01,
+    iterative_plot=True,
+    plot_period=10,
+    max_backtracks=25,
+    save_results=True,
+    samples_store_path="./samples_dir/",
+    images_store_path="./images_dir/"
+)
+```
+
+This will train a diffusion-based multi-objective solver, approximate the Pareto front of the ZDT2 problem, and store generated samples and plots in the specified directories.
+
+---
+
+<!--
+### 📚 Next steps
+
+For more advanced examples (offline mode, Bayesian mode, custom problems), see the full [documentation](https://moospread.readthedocs.io/en/latest/).
+-->
+
+## Citation
+If you find `moospread` useful in your research, please consider citing:
+```
+@inproceedings{
+  hotegni2026spread,
+  title={{SPREAD}: Sampling-based Pareto front Refinement via Efficient Adaptive Diffusion},
+  author={Hotegni, Sedjro Salomon and Peitz, Sebastian},
+  booktitle={The Fourteenth International Conference on Learning Representations},
+  year={2026},
+  url={https://openreview.net/forum?id=4731mIqv89}
+}
+```

{moospread-0.1.0.dist-info → moospread-0.1.1.dist-info}/RECORD

@@ -56,8 +56,8 @@ moospread/utils/mobo_utils/mobo/surrogate_model/thompson_sampling.py,sha256=Nmp6
 moospread/utils/offline_utils/__init__.py,sha256=MJC-fqvQnbQ0T_wjCw_QK8nKo_xpQxh0buq91fxYjFY,742
 moospread/utils/offline_utils/handle_task.py,sha256=VJjcWZC5AoPm42YN_SKgSpcyHtKBAgXgWwSFU0-Ehis,7586
 moospread/utils/offline_utils/proxies.py,sha256=DPBykB8l1XJmT5QQCAQrgMZz-8FiGEiNwN0bBdYJIaY,11218
-moospread-0.1.0.dist-info/licenses/LICENSE,sha256=YwtV5PRo6WMw5CWQMD728fSF8cWEKKfwOhek37Yi1so,1079
-moospread-0.1.0.dist-info/METADATA,sha256=4M1Tp9DjNbkMtS6hW1W4peAXAtYACmR7LmYtoYgE1n0,4005
-moospread-0.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-moospread-0.1.0.dist-info/top_level.txt,sha256=LWi5kIahDQRNXNkx55T-gefn09Bgcq8SoCxp72S-7x0,10
-moospread-0.1.0.dist-info/RECORD,,
+moospread-0.1.1.dist-info/licenses/LICENSE,sha256=YwtV5PRo6WMw5CWQMD728fSF8cWEKKfwOhek37Yi1so,1079
+moospread-0.1.1.dist-info/METADATA,sha256=-7JBHPht8mrI4_CbpCenE81_NGKot8SG-OBdDhVtoTk,5548
+moospread-0.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+moospread-0.1.1.dist-info/top_level.txt,sha256=LWi5kIahDQRNXNkx55T-gefn09Bgcq8SoCxp72S-7x0,10
+moospread-0.1.1.dist-info/RECORD,,

moospread-0.1.0.dist-info/METADATA

@@ -1,75 +0,0 @@
-Metadata-Version: 2.4
-Name: moospread
-Version: 0.1.0
-Summary: Sampling-based Pareto front Refinement via Efficient Adaptive Diffusion
-Author-email: Sedjro Salomon Hotegni <salomon.hotegni@aims.ac.rw>
-Maintainer-email: Sedjro Salomon Hotegni <salomon.hotegni@tu-dortmund.de>
-License: MIT License
-        
-        Copyright (c) 2026 Sedjro Salomon Hotegni
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-        
-Project-URL: bugs, https://github.com/safe-autonomous-systems/moo-spread/issues
-Project-URL: changelog, https://github.com/safe-autonomous-systems/moo-spread/blob/main/changelog.md
-Project-URL: Homepage, https://github.com/safe-autonomous-systems/moo-spread
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: numpy
-Requires-Dist: torch
-Provides-Extra: dev
-Requires-Dist: coverage; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Dynamic: license-file
-
-<p align="center">
-  <img src="/images/logo_well_spread.png" style="width: 30%; height: auto;">
-</p>
-
-# SPREAD: Sampling-based Pareto front Refinement via Efficient Adaptive Diffusion
-
-> SPREAD is a novel sampling-based approach for multi-objective optimization that leverages diffusion models to efficiently refine and generate well-spread Pareto front approximations. It combines the expressiveness of diffusion models with multi-objective optimization principles to achieve both high convergence to the Pareto front and excellent diversity across the objective space. SPREAD demonstrates competitive performance against state-of-the-art methods while providing a flexible framework for different optimization contexts.
-
-### 🔬 Experiments
-
-All experiment code is contained in the `/experiments` directory:
-
-* **Online setting:** `/experiments/spread/`
-* **Offline setting:** `/experiments/spread_offline/`
-* **Bayesian setting:** `/experiments/spread_bayesian/`
-
-The following Jupyter notebooks reproduce the plots shown in our paper:
-
-* `/experiments/spread/notebook_online_spread.ipynb`
-* `/experiments/spread_bayesian/notebook_bayesian_spread.ipynb`
-
-### ⚙️ Environment Setup
-
-Each experiment setting comes with its own environment file located in the corresponding folder:
-
-- Online setting: `experiments/spread/spread.yml`
-- Offline setting: `experiments/spread_offline/spread_off.yml`
-- Bayesian setting: `experiments/spread_bayesian/spread_bay.yml`
-
-To create the environment for a given setting, run:
-```bash
-conda env create -f experiments/<folder>/<env_name>.yml
-conda activate <env_name>
-```
-For example, to run the online experiments:
-```bash
-conda env create -f experiments/spread/spread.yml
-conda activate spread
-```
-The offline experiments require installing **Off-MOO-Bench** from the authors’ public repository: https://github.com/lamda-bbo/offline-moo. The datasets should be downloaded into the folder: `experiments/spread_offline/offline_moo/data/`.
-
-
-