Skip to main content

Python library designed to analyze and compare the performance of different algorithms across multiple problems using non-parametric statistical tests

Project description

SAES: Stochastic Algorithm Evaluation Suite

SAES

CI PyPI Version PyPI Python version PyPI License GitHub Pages

SAES is a Python library designed to analyse and compare the performance of stochastic algorithms (e.g. metaheuristics and some machine learning techniques) on multiple problems.

The current version of the tool offers the following capabilities:

  1. Seamless CSV data processing

    • Import and preprocess experiment results effortlessly.
    • Handle datasets of varying sizes with ease.
  2. Statistical analysis

    • Non-parametric tests:
      • Friedman test
      • Friedman aligned-rank test
      • Quade test
      • Wilcoxon signed-rank test
    • Parametric tests:
      • T-Test
      • Anova
    • Post hoc analysis:
      • Nemenyi test (critical distance)
  3. Report generation

    • Automated LaTeX reports with the following types of tables:
      • Median table
      • Median table with Friedman test
      • Median table with Wilcoxon pairwise test (pivot-based)
      • Pairwise Wilcoxon test table (1-to-1 comparison)
      • Friedman P-Values table (for multiple friedman test variations)
      • Mean table with Anova test
      • Mean table with T-Test pairewise test (pivot-based)
      • Pairwise T-Test table (1-to-1 comparison)
  4. Visualization

    • Boxplot graphs for algorithm comparison.
    • Critical distance plots for statistical significance.
    • Multiobjetive Pareto Front plots in the Multiobjective module.
    • HTML generation for intuitive analysis.
    • Bayesian Posterior Plot for probabilistic comparison of algorithm performance.
  5. CL Interface

    • Command Line feature to access the different SAES functions

This tool is aimed at researchers and developers interested in algorithm benchmarking studies for artificial intelligence, optimization, machine learning, and more.

SAES is a new project that is in its early stages of development. Feel free to open issues for comments, suggestions and bug reports.

📖 Context

A stochastic algorithm is an algorithm that incorporates randomness as part of its logic. This randomness leads to variability in outcomes even when applied to the same problem with the same initial conditions. Stochastic algorithms are widely used in various fields, including optimization, machine learning, and simulation, due to their ability to explore larger solution spaces and avoid local optima. Analyzing and comparing stochastic algorithms pose challenges due to their inherent randomness due to the fact that single run does not provide a complete picture of its performance; instead, multiple runs are necessary to capture the distribution of possible outcomes. This variability necessitates a statistical-based methodology based on descriptive (mean, median, standard deviation, ...) and inferential (hypothesis testing) statistics and visualization.

SAES assumes that the results of comparative study between a number of algorithms is provided in a CSV file with this scheme:

  • Algorithm (string): Algorithm name.
  • Instance (string): Instance name.
  • MetricName (string): Name of the quality metric used to evaluate the algorithm performace on the instance.
  • ExecutionId (integer): Unique identifier for each algorithm run .
  • MetricValue (double): Value of the metric corresponding to the run.

Example of Data file content

Algorithm Instance MetricName ExecutionId MetricValue
SVM Iris Accuracy 0 0.985
SVM Iris Accuracy 1 0.973
... ... ... ... ...

You will also need a second file to store the information of the different metrics that you to make study. The file must have the following scheme:

  • MetricName (string): Name of the quality metric used to evaluate the algorithm performace on the instance.
  • Maximize (boolean): Boolean value to show whether the metric value in that row must be maximized or minimized.

Example of Metric file content

MetricName Maximize
Accuracy True
Loss False
... ...

SAES API

The SAES library offers a range of functions categorized into three groups, corresponding to its three main features. The following links provide the SAES Tutorial and the SAES API documentation that includes a detailed list of features.

🛠 Requirements

  • Python: >= 3.10

📦 Installation

Before installing the project, we recommend creating a virtual environment to avoid conflicts with other Python projects:

python3 -m venv venv
source venv/bin/activate  # On Windows, use `venv\Scripts\activate`

Once you have activated the virtual environment, you can install the project with its dependencies using the following command:

pip install SAES

🤝 Contributors

  • GitHub Emilio Rodrigo Carreira Villalta
  • GitHub Antonio J. Nebro

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

saes-1.3.5.tar.gz (55.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

saes-1.3.5-py3-none-any.whl (11.4 MB view details)

Uploaded Python 3

File details

Details for the file saes-1.3.5.tar.gz.

File metadata

  • Download URL: saes-1.3.5.tar.gz
  • Upload date:
  • Size: 55.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for saes-1.3.5.tar.gz
Algorithm Hash digest
SHA256 99636d686d33c9d70a82e53b4945807ac1823422d74be6c180dc4e621ec4ff1d
MD5 b06feb23eff1278cf29b457182e48769
BLAKE2b-256 94be7ac20afe9611fbbfa99539e7437f145096c7d3cda33add52b9dd0f7e0911

See more details on using hashes here.

Provenance

The following attestation bundles were made for saes-1.3.5.tar.gz:

Publisher: publish.yml on jMetal/SAES

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file saes-1.3.5-py3-none-any.whl.

File metadata

  • Download URL: saes-1.3.5-py3-none-any.whl
  • Upload date:
  • Size: 11.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for saes-1.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7217bef11af07fd30ba12ee0dc3323ac927852b11e0d3d3d9d68bd9d1a8e858e
MD5 21b8073420de09ba217131d950087ee6
BLAKE2b-256 6126de1552f131e2d0d7cd8e9c470d5d9e8322d03a1bc700b09f88a7e1969597

See more details on using hashes here.

Provenance

The following attestation bundles were made for saes-1.3.5-py3-none-any.whl:

Publisher: publish.yml on jMetal/SAES

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page