Skip to content

Commit 35d4b4b

Browse files
DOC update the repo description (#116)
1 parent 2985320 commit 35d4b4b

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.rst

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
FastCan: A Fast Canonical-Correlation-Based Feature Selection Algorithm
2-
=======================================================================
3-
|conda| |Codecov| |CI| |Doc| |PythonVersion| |PyPi| |Black| |ruff| |pixi|
1+
FastCan: A Fast Canonical-Correlation-Based Greedy Search Algorithm
2+
===================================================================
3+
|conda| |Codecov| |CI| |Doc| |PythonVersion| |PyPi| |ruff| |pixi|
44

55
.. |conda| image:: https://img.shields.io/conda/vn/conda-forge/fastcan.svg
66
:target: https://anaconda.org/conda-forge/fastcan
@@ -20,28 +20,34 @@ FastCan: A Fast Canonical-Correlation-Based Feature Selection Algorithm
2020
.. |PyPi| image:: https://img.shields.io/pypi/v/fastcan
2121
:target: https://pypi.org/project/fastcan
2222

23-
.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
24-
:target: https://github.com/psf/black
25-
2623
.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
2724
:target: https://github.com/astral-sh/ruff
2825

2926
.. |pixi| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square
3027
:target: https://pixi.sh
3128

32-
FastCan is a feature selection method, which has following advantages:
29+
FastCan is a greedy search algorithm that supports:
30+
31+
#. Feature selection
32+
33+
* Supervised
34+
35+
* Unsupervised
36+
37+
* Multioutput
38+
39+
#. Term selection for time series regressors (e.g., NARX models)
3340

34-
#. Extremely **fast**.
41+
#. Data pruning (i.e., sample selection)
3542

36-
#. Support unsupervised feature selection.
3743

38-
#. Support multioutput feature selection.
44+
Key advantages:
3945

40-
#. Skip redundant features.
46+
#. **Extremely fast**
4147

42-
#. Evaluate relative usefulness of features.
48+
#. **Redundancy-aware** -- accounts for redundancy among features or samples to select the most informative subset
4349

44-
Check `Home Page <https://fastcan.readthedocs.io/en/latest/?badge=latest>`_ for more information.
50+
Check `Home Page <https://fastcan.readthedocs.io/en/latest/>`_ for more information.
4551

4652
Installation
4753
------------
@@ -84,7 +90,7 @@ NARX Time Series Modelling
8490
--------------------------
8591
FastCan can be used for system identification.
8692
In particular, we provide a submodule `fastcan.narx` to build Nonlinear AutoRegressive eXogenous (NARX) models.
87-
For more information, check our `Home Page <https://fastcan.readthedocs.io/en/latest/?badge=latest>`_.
93+
For more information, check our `Home Page <https://fastcan.readthedocs.io/en/latest/>`_.
8894

8995

9096
Support Free-Threaded Wheels

0 commit comments

Comments
 (0)