Package: scikit-XCS
Master Status:scikit-XCSThe scikit-XCS package includes a sklearn-compatible Python implementation of XCS, the most popular and best studied learning classifier system algorithm to date. In general, Learning Classifier Systems (LCSs) are a classification of Rule Based Machine Learning Algorithms that have been shown to perform well on problems involving high amounts of heterogeneity and epistasis. Well designed LCSs are also highly human interpretable. LCS variants have been shown to adeptly handle supervised and reinforced, classification and regression, online and offline learning problems, as well as missing or unbalanced data. These characteristics of versatility and interpretability give LCSs a wide range of potential applications, notably those in biomedicine. This package isstill under active developmentand we encourage you to check back on this repository for updates.This version of scikit-XCS is suitable for single step, classification problems. It has not yet been developed for multi-step reinforcement learning problems nor regression problems. Within these bounds however, scikit-XCS can be applied to almost any supervised classification data set and supports:Feature sets that are discrete/categorical, continuous-valued or a mix of bothData with missing valuesBinary Classification Problems (Binary Endpoints)Multi-class Classification Problems (Multi-class Endpoints)Built into this code, is a strategy to 'automatically' detect from the loaded data, these relevant above characteristics so that they don't need to be parameterized at initialization.The core Scikit package only supports numeric data. However, an additional StringEnumerator Class is provided that allows quick data conversion from any type of data into pure numeric data, making it possible for natively string/non-numeric data to be run by scikit-XCS.In addition, powerful data tracking collection methods are built into the scikit package, that continuously tracks features every iteration such as:Approximate AccuracyAverage Population GeneralityMacro & Micropopulation SizeMatch Set and Action Set SizesNumber of classifiers subsumed/deleted/coveredNumber of crossover/mutation operations performedTimes for matching, deletion, subsumption, selection, evaluationThese values can then be exported as a csv after training is complete for analysis using the built in "export_iteration_tracking_data" method.In addition, the package includes functionality that allows the final rule population to be exported as a csv after training.UsageFor more information on how to use scikit-XCS, please refer to thescikit-XCS User GuideJupyter Notebook inside this repository.Usage TLDR#Import Necessary Packages/ModulesfromskXCSimportXCSimportnumpyasnpimportpandasaspdfromsklearn.model_selectionimportcross_val_score#Load Data Using Pandasdata=pd.read_csv('myDataFile.csv')#REPLACE with your own dataset .csv filenamedataFeatures=data.drop(actionLabel,axis=1).values#DEFINE actionLabel variable as the Str at the top of your dataset's action columndataActions=data[actionLabel].values#Shuffle Data Before CVformatted=np.insert(dataFeatures,dataFeatures.shape[1],dataActions,1)np.random.shuffle(formatted)dataFeatures=np.delete(formatted,-1,axis=1)dataActions=formatted[:,-1]#Initialize XCS Modelmodel=XCS(learning_iterations=5000)#3-fold CVprint(np.mean(cross_val_score(model,dataFeatures,dataActions,cv=3)))LicensePlease see the repositorylicensefor the licensing and usage information for scikit-XCS.Generally, we have licensed scikit-XCS to make it as widely usable as possible.Installationscikit-XCS is built on top of the following Python packages:numpypandasscikit-learnOnce the prerequisites are installed, you can install scikit-XCS with a pip command:pip/pip3 install scikit-XCSWe strongly recommend you use Python 3. scikit-XCS does not support Python 2, given its depreciation in Jan 1 2020. If something goes wrong during installation, make sure that your pip is up to date and try again.pip/pip3 install --upgrade pipContributing to scikit-XCSscikit-XCS is an open source project and we'd love if you could suggest changes!Fork the project repository to your personal account and clone this copy to your local diskCreate a branch from master to hold your changes: (e.g.git checkout -b my-contribution-branch)Commit changes on your branch. Remember to never work on any other branch but your own!When you are done, push your changes to your forked GitHub repository withgit push -u origin my-contribution-branchCreate a pull request to send your changes to the scikit-XCS maintainers for review.Before submitting your pull requestIf your contribution changes XCS in any way, make sure you update the Jupyter Notebook documentation and the README with relevant details. If your contribution involves any code changes, update the project unit tests to test your code changes, and make sure your code is properly commented to explain your rationale behind non-obvious coding practices.After submitting your pull requestAfter submitting your pull request, Travis CI will run all of the project's unit tests. Check back shortly after submitting to make sure your code passes these checks. If any checks come back failed, do your best to address the errors.