Skip to content

Commit

Permalink
MRG: updating pitch in README (#164)
Browse files Browse the repository at this point in the history
* Updating pitch

Cosmit / typos and improved readme for front page.

* Pass on README

Co-authored-by: mathurinm <mathurin.massias@gmail.com>
  • Loading branch information
josephsalmon and mathurinm committed Nov 10, 2020
1 parent 76090e0 commit b4a35ad
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.rst
Expand Up @@ -3,9 +3,16 @@ celer

|image0| |image1|

Fast algorithm to solve Lasso-like problems with dual extrapolation. Currently, the package handles the following problems: Lasso, Sparse Logistic regression, Group Lasso and Multitask Lasso.
The estimators follow the scikit-learn API, come with automated cross-validation, and support sparse and dense data with feature centering and normalization.
The solvers used allow for solving large scale problems with millions of features.
Fast algorithm to solve Lasso-like problems with dual extrapolation. Currently, the package handles the following problems:

- Lasso
- weighted Lasso
- Sparse Logistic regression
- Group Lasso
- Multitask Lasso.

The estimators follow the scikit-learn API, come with automated parallel cross-validation, and support both sparse and dense data, with optionnaly feature centering, normalization, and unpenalized intercept fitting.
The solvers used allow for solving large scale problems with millions of features, up to 100 times faster than scikit-learn.

Documentation
=============
Expand All @@ -16,7 +23,7 @@ of the documentation.
Install the released version
============================

Assuming you have a working Python environment, e.g. with Anaconda you
Assuming you have a working Python environment, e.g., with Anaconda you
can `install celer with pip <https://pypi.python.org/pypi/celer/>`__.

From a console or terminal install celer with pip:
Expand Down Expand Up @@ -58,6 +65,7 @@ Dependencies
============

All dependencies are in the ``./requirements.txt`` file.
They are installed automatically when ``pip install -e .`` is run.

Cite
====
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
@@ -1,5 +1,6 @@
Cython>=0.26
download
libsvmdata
matplotlib>=2.0.0
numpy>=1.12
scikit-learn>=0.23
Expand Down

0 comments on commit b4a35ad

Please sign in to comment.