Skip to main content

This library is built to perform feature selection in clustering models

Project description

📊 FeatureClus: Feature Selection for Clustering Models

Welcome to FeatureClus, a Python library designed to simplify feature selection for clustering models. This tool helps you select the most relevant features that enhance clustering performance, ensuring you avoid the "curse of dimensionality" and make your clustering algorithms more efficient and interpretable. 🧠

🔍 How It Works

The feature selection process is driven by evaluating how each feature impacts the clustering results. FeatureClus uses an isolated data shift for each feature to assess its importance. The process follows these steps:

  1. MinMaxScaler: First, we scale the features using MinMaxScaler to normalize the data.
  2. PCA (80% variance): Next, we apply Principal Component Analysis (PCA) to reduce dimensionality, retaining 80% of the variance.
  3. DBSCAN Clustering: After reducing the dimensionality, DBSCAN is used to perform clustering.
  4. Silhouette Score Calculation: For each feature, we calculate the silhouette score to evaluate the quality of the clusters. The silhouette score represents how similar an object is to its own cluster compared to other clusters.
  5. Data Shift and Feature Importance: By applying isolated shifts to each feature and recalculating the silhouette score, we measure how the score changes. The absolute difference in the silhouette score after shifting each feature is used to rank the features by importance.
  6. Gower matrix: In case of dealing with categorical variables, please use gower matrix.

This method ensures that the features are evaluated for their individual contribution to the clustering process, allowing you to focus on the most impactful features.

🚀 Key Features

  • 🔍 Feature Ranking: Ranks features based on the absolute change in silhouette score after applying isolated shifts to each feature.
  • 📈 Cluster Evaluation Metrics: Calculates the silhouette score to assess the clustering quality and the influence of each feature.
  • 💻 Easy-to-Use API: A simple, intuitive API that can be easily integrated into your machine learning pipeline.

📦 Installation

To install the library, run the following command:

pip install featclus

📊 Example

Here is a quick example of how to use FeatureClus with a clustering algorithm (e.g., KMeans):

from featureclus.model import FeatureSelection
from sklearn.datasets import make_blobs
import pandas as pd

# Sample DataFrame
data, labels = make_blobs(n_samples=10000, centers=7, n_features=15, random_state=42)
df = pd.DataFrame(data, columns=[f"Feature_{i}" for i in range(15)])

# Initialize the FeatureSelection
model = FeatureSelection(data=df, shifts=[1, 25, 50, 75, 100], n_jobs=-1, use_gower=False)

# See how the metrics are important
metrics = model.get_metrics()

🛠️ Methods

get_metrics()

Returns metrics that assess how each feature contributes to clustering.

plot_results(n_features)

Selects the top n_features features based on their importance to clustering results.

☕ Support the Project

If you find this inventory optimization tool helpful and would like to support its continued development, consider buying me a coffee. Your support helps maintain and improve this project!

Buy Me A Coffee

Other Ways to Support

  • ⭐ Star this repository
  • 🍴 Fork it and contribute
  • 📢 Share it with others who might find it useful
  • 🐛 Report issues or suggest new features

Your support, in any form, is greatly appreciated! 🙏

Contributions

  1. Open a issue.
  2. Create a new branch based for solving this.
  3. Send the PR to dev to test the inner functionality.

📝 License

This project is licensed under the MIT License. See the LICENSE file for more details.


Happy clustering! 🎉

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

featclus-0.1.5.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

featclus-0.1.5-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file featclus-0.1.5.tar.gz.

File metadata

  • Download URL: featclus-0.1.5.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for featclus-0.1.5.tar.gz
Algorithm Hash digest
SHA256 06835afc3212a479bf4726127ccac8bb7a8bc6e2d6476c4cfe7296f941dacbf9
MD5 93c3c7db1a3e75c227a8667dd739b722
BLAKE2b-256 b4bfd2f4649b2c8d2a63e5699629dcac900794e6726ddcc56906ef0412ca27f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for featclus-0.1.5.tar.gz:

Publisher: cd.yaml on sebassaras02/featclus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file featclus-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: featclus-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for featclus-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2a25fdc8c26950ddb2c9f0c0a6d7407f16251be18d63ab5f1d473d4e2cb17a9f
MD5 0de044abbdee541d03474fe1bd944a2e
BLAKE2b-256 bf442f7c66a8c086aa52719c1118561d9c8142a28ff67e6bcdb9d1290f1746e2

See more details on using hashes here.

Provenance

The following attestation bundles were made for featclus-0.1.5-py3-none-any.whl:

Publisher: cd.yaml on sebassaras02/featclus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page