Merge pull request #38 from mlojek/22

22

Author: mlojek

README.md

@@ -23,12 +23,16 @@ make install
 ```
 
 ## Try the demos
-Learn how to use optilab by using our demo notebook. See `demo/tutorial.ipynb`.
+Learn how to use optilab and fit it to your needs with demo notebooks in `demo` directory.
 
 ## CLI tool
 Optilab comes with a powerful CLI tool to easily summarize your experiments. It allows for plotting the results and performing statistical testing to check for statistical significance in optimization results.
 ```
-usage: python -m optilab [-h] [--hide_plots] [--test_y] [--test_evals] [--entries ENTRIES [ENTRIES ...]] [--raw_values] [--hide_outliers] pickle_path
+usage: python -m optilab [-h] [--aggregate_pvalues] [--aggregate_stats]
+                         [--entries ENTRIES [ENTRIES ...]] [--hide_outliers]
+                         [--hide_plots] [--no_save] [--raw_values]
+                         [--save_path SAVE_PATH] [--test_evals] [--test_y]
+                         pickle_path
 
 Optilab CLI utility.
 
@@ -37,13 +41,22 @@ positional arguments:
 
 options:
   -h, --help            show this help message and exit
-  --hide_plots          Hide plots when running the script.
-  --test_y              Perform Mann-Whitney U test on y values.
-  --test_evals          Perform Mann-Whitney U test on eval values.
+  --aggregate_pvalues   Aggregate pvalues of stat tests against run 0 in each pickle
+                        file into one table.
+  --aggregate_stats     Aggregate median and iqr for all processed runs into one table.
   --entries ENTRIES [ENTRIES ...]
-                        Space separated list of indexes of entries to include in analysis.
-  --raw_values          If specified, y values below tolerance are not substituted by tolerance value.
+                        Space separated list of indexes of entries to include in
+                        analysis.
   --hide_outliers       If specified, outliers will not be shown in the box plot.
+  --hide_plots          Hide plots when running the script.
+  --no_save             If specified, no artifacts will be saved.
+  --raw_values          If specified, y values below tolerance are not substituted by
+                        tolerance value.
+  --save_path SAVE_PATH
+                        Path to directory to save the artifacts. Default is the user's
+                        working directory.
+  --test_evals          Perform Mann-Whitney U test on eval values.
+  --test_y              Perform Mann-Whitney U test on y values.
 ```
 
 ## Docker

docs/cmaopts.json

@@ -13,7 +13,7 @@
 project = 'optilab'
 copyright = '2025, Marcin Łojek'
 author = 'Marcin Łojek'
-release = '21'
+release = '22'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/conf.py

@@ -28,14 +28,13 @@ dependencies = [
     "sphinx-rtd-theme",
     "tabulate",
     "tqdm",
-    "tqdm",
     "typing",
 ]
 description = "Simple framework for optimization functions and metamodels"
 name = "optilab"
 readme = "README.md"
 requires-python = ">=3.11.9"
-version = "21"
+version = "22"
 
 [project.urls]
 Homepage = "https://github.com/mlojek/optilab"