Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MRG: updating pitch in README #164

Merged
merged 2 commits into from Nov 10, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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