Skip to content

Commit 1f8eabd

Browse files
committed
bumped up version number, included Python 3.11&12, expanded readme
1 parent 3a98766 commit 1f8eabd

File tree

3 files changed

+816
-883
lines changed

3 files changed

+816
-883
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
[![PyPI version](https://img.shields.io/pypi/v/significance-analysis?color=informational)](https://pypi.org/project/significance-analysis/)
44
[![Python versions](https://img.shields.io/pypi/pyversions/significance-analysis)](https://pypi.org/project/significance-analysis/)
5-
65
[![License](https://img.shields.io/pypi/l/significance-analysis?color=informational)](LICENSE)
76

87
This package is used to analyse datasets of different HPO-algorithms performing on multiple benchmarks, using a Linear Mixed-Effects Model-based approach.
@@ -13,17 +12,19 @@ As indicated with the `v0.x.x` version number, Significance Analysis is early st
1312

1413
## Documentation
1514

16-
Please have a look at our [example](significance_analysis_example/analysis_example.ipynb).
17-
The dataset should be a pandas dataframe of the following format:
15+
For an interactive overview, please have a look at our [example](significance_analysis_example/analysis_example.ipynb).
16+
17+
Every dataset should be a pandas dataframe of the following format:
1818

1919
| algorithm | benchmark | metric | optional: budget/prior/... |
2020
| ---------- | ---------- | ------ | -------------------------- |
21-
| Algorithm1 | Benchmark1 | x.xxx | 1.0 |
22-
| Algorithm1 | Benchmark1 | x.xxx | 2.0 |
23-
| Algorithm1 | Benchmark2 | x.xxx | 1.0 |
21+
| Algorithm1 | Benchmark1 | 3.141 | 1.0 |
22+
| Algorithm1 | Benchmark1 | 6.283 | 2.0 |
23+
| Algorithm1 | Benchmark2 | 2.718 | 1.0 |
2424
| ... | ... | ... | ... |
25-
| Algorithm2 | Benchmark2 | x.xxx | 2.0 |
25+
| Algorithm2 | Benchmark2 | 0.621 | 2.0 |
2626

27+
As it is used to train a model, there can not be missing values, but duplicates are allowed.
2728
Our function `dataset_validator` checks for this format.
2829

2930
## Installation
@@ -111,3 +112,7 @@ scores = metafeature_analysis(data, ("HB", "PB"), "prior")
111112
```
112113

113114
For more details and features please have a look at our [example](significance_analysis_example/analysis_example.py).
115+
116+
## Contributing
117+
118+
We welcome contributions from everyone, feel free to raise issues or submit pull requests.

0 commit comments

Comments
 (0)