diff --git a/README.md b/README.md index ee2b14243aa02129d979c99d73c41028a532c28e..50e4fc2719e184fef44a0cb5c5ca654b0ddb0662 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Screen & Relax : A fast solving procedure for the Elastic-Net problem by safe identification of the solution support. -This repository contains numerical procedures linked to the paper +This repository implements the Screen & Relax method solving the Elastic-Net problem. We introduced this method in **> ADD CITATION** @@ -13,12 +13,8 @@ If you encounter a bug or something unexpected, please let me know by raising an Dependencies : * [NumPy](http://www.numpy.org) * [SciPy](https://www.scipy.org) - -Additional dependencies required to run experiments * [Matplotlib](http://matplotlib.org) * [Pandas](https://pandas.pydata.org) -* [PyYAML](https://pyyaml.org) -* [Jupyter](https://jupyter.org) ## Install instructions @@ -27,7 +23,7 @@ Additional dependencies required to run experiments git clone https://gitlab.insa-rennes.fr/Theo.Guyard/screen-and-relax.git ``` -2. Enter in the project folder +2. Enter the project folder ```bash cd screen-and-relax ``` @@ -61,7 +57,7 @@ python exp/ICASSP/convergence.py python exp/ICASSP/performance_profiles.py ``` -You can also edit the experimental setup directly in the script, which is well commented. +You can also edit the experimental setup directly in the script, which is well documented. ## Running demo examples @@ -70,7 +66,7 @@ We also provide a notebook explaining how to use the `srenet` package. You can u cd notebooks jupyter notebook ``` -You may have to install Jupyter. Please refer to the [Jupyter website](https://jupyter.org) for install instructions. +You may have to install Jupyter. Please refer to the [Jupyter website](https://jupyter.org). ## Licence