diff --git a/README.md b/README.md index 3257bfa..c4c44b1 100644 --- a/README.md +++ b/README.md @@ -24,88 +24,111 @@ --- -## Welcome to the SKLearn XAI Components Library +## Table of Contents -The **SKLearn XAI Components Library** provides a simple and intuitive way to integrate **scikit-learn** machine learning models, datasets, and evaluation tools within the **XAI** framework. With this library, you can easily manage the end-to-end workflow for data handling, model training, and evaluation using scikit-learn's extensive set of algorithms and features. +- [Preview](#preview) +- [Prerequisites](#prerequisites) +- [Main Components Library](#main-components-library) +- [Try the Examples](#try-the-examples) +- [Installation](#installation) -In this guide, you will find the steps to install the library, set up a workflow, and get started with training and evaluating machine learning models. +## Xircuits Component Library for SkLearn +This library enables seamless integration of scikit-learn's machine learning models, datasets, and evaluation tools into Xircuits, streamlining data workflows, model training, and performance evaluation." -## Table of Contents +## Preview + +### The Example: +![sklearn_example](https://github.com/user-attachments/assets/565a4919-8b67-4ced-9ad5-47a2645bf3c6) -- [Prerequisites](#prerequisites) -- [Installation](#installation) -- [Getting Started with SKLearn XAI Components](#getting-started-with-sklearn-xai-components) - - [Example Workflow: RandomForestClassifier](#example-workflow-randomforestclassifier) -- [Components Overview](#components-overview) - - [Dataset Handling](#dataset-handling) - - [Data Preprocessing](#data-preprocessing) - - [Model Training](#model-training) - - [Model Evaluation](#model-evaluation) -- [Contributing](#contributing) +### The Result: +![sklearn_result](https://github.com/user-attachments/assets/c2bc95b4-41f9-4d8d-a1a3-9d6a9097d3c9) ## Prerequisites -Before using this library, you’ll need the following: +Before you begin, you will need the following: -1. **Python 3.8** or higher -2. **scikit-learn**: Core machine learning algorithms -3. **pandas**: For handling CSV and tabular data -4. **Xircuits**: To integrate the components into your workflows +1. Python3.9+. +2. Xircuits. +## Main Components Library +### SKLearnRandomForestClassifier Component: +Initializes a RandomForestClassifier for high-accuracy classification tasks, using specified or default parameters. -## Installation +SKLearnRandomForestClassifier -To use this component library, ensure that you have an existing [Xircuits setup](https://xircuits.io/docs/main/Installation). You can then install the SKLearn library using the [component library interface](https://xircuits.io/docs/component-library/installation#installation-using-the-xircuits-library-interface), or through the CLI using: +#### SKLearnLogisticRegression Component: +Initializes a LogisticRegression model, widely used for binary classification and multiclass tasks using a one-vs-rest strategy. -``` -xircuits install sklearn -``` +SKLearnLogisticRegression -You can also do it manually by cloning and installing it. -```bash -# To clone the repository into your Xircuits project directory -git clone https://github.com/XpressAI/xai-sklearn.git xai_components/xai_sklearn +### SKLearnSVC Component: +Initializes an Support Vector Classifier (SVC), effective in high-dimensional spaces and suitable for cases with more features than samples. -# Install required dependencies -pip install -r xai_components/xai_sklearn/requirements.txt -``` +SKLearnSVC -## Getting Started with SKLearn XAI Components +### SKLearnKNeighborsClassifier Component: +Initializes a KNeighborsClassifier, an instance-based learning model that classifies data based on stored training instances without building a generalized model. +SKLearnKNeighborsClassifier -Now that you have installed the required libraries and components, you can begin using the SKLearn XAI Components Library to build machine learning workflows in Xircuits. Please follow the documentation and examples provided in the library to learn how to create, customize, and manage machine learning components using SKLearn XAI. +### SKLearnDecisionTreeClassifier Component: +Initializes a DecisionTreeClassifier, a versatile model for classification and regression that uses a tree structure to make decisions through yes/no questions. -## Try the Example +SKLearnDecisionTreeClassifier -We have provided an example workflow to help you get started with the SKLearn XAI Components Library. Give it a try and see how you can create a custom machine learning workflow for your projects. -### Train Evaluate +### SKLearnGradientBoostingClassifier Component: +Initializes a GradientBoostingClassifier that builds models additively in stages, optimizing differentiable loss functions for improved accuracy. -This example demonstrates a machine learning workflow in Xircuits using the SKLearn XAI Components Library. It creates a pipeline for loading the Iris dataset, splitting it, training a RandomForestClassifier, and evaluating its performance +SKLearnGradientBoostingClassifier -## Components Library +### SKLearnSVR Component: +Initializes a Support Vector Regression (SVR) model, applying Support Vector Machines (SVM) principles to regression with customizable kernels for handling complex datasets. -The SKLearn XAI Components Library offers a variety of components designed to facilitate every stage of the machine learning process. You are encouraged to explore these components and consult their documentation to enhance your understanding and application in building effective machine learning workflows. +SKLearnSVC -## Contributing +### SKLearnMultinomialNB Component: +Initializes a MultinomialNB model, ideal for discrete features like word counts and effective for multi-class text classification. -We welcome contributions to the **SKLearn XAI Components Library**! If you would like to contribute: +SKLearnMultinomialNB -1. Fork the repository. -2. Create a new branch for your feature or bug fix. -3. Open a pull request with a detailed description of your changes. -Please feel free to suggest new components, improvements, or optimizations. If you encounter any issues or have ideas for enhancements, you can open an issue in the repository. +### SKLearnRidgeRegression Component: +Initializes a Ridge Regression model that mitigates overfitting by penalizing large coefficients, enhancing the robustness of linear regression. ---- +SKLearnRidgeRegression + + +### SKLearnKMeans Component: +Initializes a KMeans model, an unsupervised algorithm that partitions data into k clusters by assigning each point to the nearest cluster mean. -### License +SKLearnKMeans -This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information. +## Try the Examples +We have provided an example workflow to help you get started with the Sklearn component library. Give it a try and see how you can create custom Sklearn components for your applications. + +### TrainEvaluate +Check out the `TrainEvaluate` workflow. This example uses Sklearn components to load the Iris dataset, split it into training and testing sets, and train a Random Forest model. It evaluates the model's performance with classification metrics, showcasing an end-to-end machine learning pipeline. + +## Installation + +To use this component library, ensure that you have an existing [Xircuits setup](https://xircuits.io/docs/main/Installation). You can then install the SKLearn library using the [component library interface](https://xircuits.io/docs/component-library/installation#installation-using-the-xircuits-library-interface), or through the CLI using: + +``` +xircuits install sklearn +``` + +You can also do it manually by cloning and installing it: + +``` +# base Xircuits directory +git clone https://github.com/XpressAI/xai-sklearn xai_components/xai_sklearn +pip install -r xai_components/xai_sklearn/requirements.txt +``` \ No newline at end of file