Skip to content

DOC update the repo description #116

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.

Sign up for GitHub

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

Merged
MatthewSZhang merged 1 commit into from
Jun 20, 2025
Merged

DOC update the repo description #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
FastCan: A Fast Canonical-Correlation-Based Feature Selection Algorithm
=======================================================================
|conda| |Codecov| |CI| |Doc| |PythonVersion| |PyPi| |Black| |ruff| |pixi|
FastCan: A Fast Canonical-Correlation-Based Greedy Search Algorithm
===================================================================
|conda| |Codecov| |CI| |Doc| |PythonVersion| |PyPi| |ruff| |pixi|

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

.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

.. |ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff

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

FastCan is a feature selection method, which has following advantages:
FastCan is a greedy search algorithm that supports:

#. Feature selection

* Supervised

* Unsupervised

* Multioutput

#. Term selection for time series regressors (e.g., NARX models)

#. Extremely **fast**.
#. Data pruning (i.e., sample selection)

#. Support unsupervised feature selection.

#. Support multioutput feature selection.
Key advantages:

#. Skip redundant features.
#. **Extremely fast**

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

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

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


Support Free-Threaded Wheels
Expand Down