Skip to content

Commit 5d323e7

Browse files
committed
Update README.md
Updating README to include new performance changes.
1 parent fcf50eb commit 5d323e7

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,40 @@ Once the prerequisites are installed, you should be able to install scikit-rebat
6767
pip install skrebate
6868
```
6969

70+
Alternatively, for development you can use
71+
72+
```
73+
pip install -r requirements.txt
74+
```
75+
7076
Please [file a new issue](https://github.com/EpistasisLab/scikit-rebate/issues/new) if you run into installation problems.
7177

78+
## Performance Testing
79+
80+
This repo provides two basic tools for performance testing on your algorithms. This is important because in practice the datasets fed to the algorithms will be fairly large, and small performance regressions in core functions can be multiplied.
81+
82+
The first tool for performance testing is
83+
84+
```
85+
python performance_tests.py
86+
```
87+
88+
This can also be called to perform a parameter sweep across many different dataset sizes to extrapolate the performance characteristics on larger datasets.
89+
90+
```
91+
python performance_tests.py sweep
92+
```
93+
94+
Once a sweep has been run - you can use the Jupyter notebook `Visualize_Performance_Benchmarks.ipynb` to visualize the results.
95+
96+
Additionally - a performance graph can be generated from cprofile data via
97+
98+
```
99+
./run_performance_benchmark.sh
100+
```
101+
102+
This will produce a data file and a png graph visualization in the main directory. Please note that this requires the installation of `gprof2dot` and `Graphviz`.
103+
72104
## Usage
73105

74106
We have designed the Relief algorithms to be integrated directly into scikit-learn machine learning workflows. For example, the ReliefF algorithm can be used as a feature selection step in a scikit-learn pipeline as follows.

0 commit comments

Comments
 (0)