craceplot 0.1.0__py3-none-any.whl

docs/_static/js/navbar.js

@@ -0,0 +1,40 @@
+// document.addEventListener("DOMContentLoaded", function () {
+
+//     const nav = document.getElementById("top_nav");
+//     if (!nav) return;
+
+//     let lastScroll = 0;
+
+//     window.addEventListener("scroll", () => {
+//         const currentScroll = window.pageYOffset;
+
+//         if (currentScroll <= 0) {
+//             nav.style.transform = "translateY(0)";
+//             return;
+//         }
+
+//         if (currentScroll > lastScroll) {
+//             nav.style.transform = "translateY(-100%)";
+//         } else {
+//             nav.style.transform = "translateY(0)";
+//         }
+
+//         lastScroll = currentScroll;
+//     });
+
+// });
+
+function updateThemeColor(mode) {
+    let meta = document.querySelector('meta[name="theme-color"]');
+    if (!meta) {
+        meta = document.createElement('meta');
+        meta.name = "theme-color";
+        document.head.appendChild(meta);
+    }
+
+    meta.content = "#2c2c30";
+}
+
+document.addEventListener("DOMContentLoaded", function () {
+    updateThemeColor(document.documentElement.dataset.mode);
+});

docs/_toc.yml

@@ -0,0 +1,5 @@
+format: jb-book
+root: index
+chapters:
+  - file: references/index
+  - file: history/changelog

docs/index.md

@@ -0,0 +1,4 @@
+```{include} ../README.md
+:relative-docs: docs/
+:relative-images: true
+```

docs/references/404.md

@@ -0,0 +1,14 @@
+<!-- Content not found. Please use links in the navbar.
+
+# Page not found (404) -->
+
+---
+title: Page not found
+---
+
+# 404
+
+The page you requested does not exist.
+
+- Return to the homepage.
+- Use the search bar.

docs/references/authors.md

@@ -0,0 +1,46 @@
+# Authors and Citation
+
+## Authors
+- **Yunshuang Xiao**. Author, maintainer. [![ORCID][orcid-icon]](https://orcid.org/0009-0003-6752-8627)
+
+
+## Citation
+
+Source:
+[`CITIATION`](./citiation.bib)
+
+- Yunshuang Xiao, Leslie Pérez Cáceres, Manuel López-Ibáñez, and Thomas Stützle. 
+   **Algorithm Configuration via Continuously Racing: Preliminary Results**(
+    https://doi.org/10.1145/3583133.3596408). *In Proceedings 
+   of the Companion Conference on Genetic and Evolutionary Computation (GECCO '23 Companion
+   )*. Association for Computing Machinery, New York, NY, USA, 1744–1752. 
+   doi: 10.1145/3583133.3596408
+
+        @inproceedings{10.1145/3583133.3596408,
+        title = {Algorithm Configuration via Continuously Racing: Preliminary Results},
+        author = {Xiao, Yunshuang and Pérez Cáceres, Leslie and López-Ibáñez, Manuel and Stützle, Thomas},
+        booktitle = {Proceedings of the Companion Conference on Genetic and Evolutionary Computation},
+        pages = {1744-1752},
+        year = {2023},
+        }
+
+
+- Manuel López-Ibáñez, Jérémie Dubois-Lacoste, Leslie Pérez Cáceres,
+  Thomas Stützle, and Mauro Birattari. **The irace package: Iterated
+  Racing for Automatic Algorithm
+  Configuration.**(http://dx.doi.org/10.1016/j.orp.2016.09.002)
+  *Operations Research Perspectives*, 2016. doi:
+  10.1016/j.orp.2016.09.002
+
+        @Article{,
+        title = {The irace package: Iterated Racing for Automatic Algorithm Configuration},
+        author = {Manuel López-Ibáñez and Jérémie Dubois-Lacoste and Leslie {Pérez Cáceres} and Thomas Stützle and Mauro Birattari},
+        year = {2016},
+        journal = {Operations Research Perspectives},
+        doi = {10.1016/j.orp.2016.09.002},
+        volume = {3},
+        pages = {43--58},
+        }
+
+
+[orcid-icon]: https://orcid.org/sites/default/files/images/orcid_16x16.png

docs/references/citiation.bib

@@ -0,0 +1,17 @@
+@inproceedings{10.1145/3583133.3596408,
+author = {Xiao, Yunshuang and P\'{e}rez C\'{a}ceres, Leslie and L\'{o}pez-Ib\'{a}\~{n}ez, Manuel and St\"{u}tzle, Thomas},
+title = {Algorithm Configuration via Continuously Racing: Preliminary Results},
+year = {2023},
+isbn = {9798400701207},
+publisher = {Association for Computing Machinery},
+address = {New York, NY, USA},
+url = {https://doi.org/10.1145/3583133.3596408},
+doi = {10.1145/3583133.3596408},
+abstract = {Automatic algorithm configuration procedures aim at supporting the design and application of optimization algorithms by providing specialized tools to automatically adjust their parameters to use the available computational resources effectively. The irace configurator is a state-of-the-art method implementing an iterated racing procedure that, in its current implementation, allows parallel executions of the target algorithm. Parallel evaluation is crucial for the efficient use of computational resources, reducing the wall-clock time that the configuration process needs to find a good configuration. In this work, we propose an alternative to irace that performs a single race instead of iterative races. The continuously racing configurator (crace) evaluates, removes and generates new configurations asynchronously, granting a high level of flexibility regarding the configuration process when compared to the previous iterative scheme. In this paper, we provide a general description of the crace configuration procedure and perform initial exploratory experiments on five configuration scenarios. These experiments focus on evaluating the effect of the minimum number of configurations required to be involved in the race and the number of parallel evaluations. The first results are encouraging, showing that crace can be a competitive procedure on the scenarios evaluated.},
+booktitle = {Proceedings of the Companion Conference on Genetic and Evolutionary Computation},
+pages = {1744–1752},
+numpages = {9},
+keywords = {racing methods, automated algorithm design, automated algorithm configuration},
+location = {Lisbon, Portugal},
+series = {GECCO '23 Companion}
+}

docs/references/functions/index.md

@@ -0,0 +1,5 @@
+# All functions
+
+| function | description |
+|---|---|
+|[param_boxplot( )](./param_boxplot.ipynb)|Boxplot for parameters of selected configurations|

docs/references/functions/param_boxplot.ipynb

@@ -0,0 +1,19 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "7eb5c5f0",
+   "metadata": {},
+   "source": [
+    "# param_boxplot"
+   ]
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}

docs/references/index.md

@@ -0,0 +1,44 @@
+References
+==========
+
+Authors
+-------
+
+Source: [`authors and citiation`](./authors.md)
+
+**Maintainers:** [Yunshuang Xiao](https://orcid.org/0009-0003-6752-8627)
+
+**Authors:** [Yunshuang Xiao](https://orcid.org/0009-0003-6752-8627).
+
+**Contact**: <race.autoconfig@gmail.com>
+
+**Report a bug**: <https://github.com/race-autoconfig/craceplot/issues>
+
+**Discussions**: <https://github.com/race-autoconfig/craceplot/discussions>
+
+
+License
+-------
+
+Source: [`License`](./license.md)
+
+craceplot is free software (software libre): you can redistribute it and/or 
+modify it under the terms of the MIT License.
+
+This program is distributed in the hope that it will be useful, but WITHOUT 
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
+FOR A PARTICULAR PURPOSE. 
+
+**IMPORTANT NOTE:** Please be aware that the fact that this program is released 
+as Free Software does not excuse you from scientific propriety, which obligates 
+you to give appropriate credit! If you write a scientific paper describing research that 
+made substantive use of this program, it is your obligation as a scientist to 
+(a) mention the fashion in which this software was used in the Methods section; 
+(b) mention the algorithm in the References section. 
+
+craceplot is built as an additional tool for the crace package:
+  crace: Continuous Racing for Automatic Algorithm Configuration
+  Copyright (c) 2026 crace developers
+
+
+

docs/references/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2026 crace developers
+
+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.

docs/references/others/favicon_io/about.txt

@@ -0,0 +1,6 @@
+This favicon was generated using the following font:
+
+- Font Title: Medula One
+- Font Author: undefined
+- Font Source: https://fonts.gstatic.com/s/medulaone/v19/YA9Wr0qb5kjJM6l2V0yukiEqs7GtlvY.ttf
+- Font License: undefined)

docs/references/others/favicon_io/site.webmanifest

@@ -0,0 +1 @@
+{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

docs/requirements.txt

@@ -0,0 +1,5 @@
+Sphinx<7
+jupyter-book==0.15.1
+nbconvert==7.16.6
+pydata-sphinx-theme==0.14.4
+piccolo_theme==0.24.0