API Reference
The RFFLearn library consists of the several sub modules. Click the module name to see the details of each module.
| Sub module name | Description |
|---|---|
| rfflearn.cpu | Regressors and classifiers of random Fourier features on CPU. |
| rfflearn.gpu | Regressors and classifiers of random Fourier features on GPU. |
| rfflearn.explainer | Classes and functions to get model explanation for RFF-based models. |
| rfflearn.tuner | Classes and functions for automatic hyperparameter tuning. |
rfflearn.cpu
Sub module for machine learning algorithm of random Fourier feature runnable on CPU. This sub module contains machine learning algorithm (e.g. regressors, classifiers) which is designed to be run on CPU. Interfaces of classes and functions in this module have quite close interfaces with scikit-learn library. Most (but not all) of the classes uses scikit-learn as a back end.
| Class name | Description |
|---|---|
| rfflearn.cpu.RFFCCA | Canonical correlation analysis with random Fourier features. |
| rfflearn.cpu.RFFGPC | Gaussian process classification with random Fourier features. |
| rfflearn.cpu.RFFGPR | Gaussian process regression with random Fourier features. |
| rfflearn.cpu.RFFPCA | Principal component analysis with random Fourier features. |
| rfflearn.cpu.RFFRegression | Regression with random Fourier features. |
| rfflearn.cpu.RFFSVC | Support vector classification with random Fourier features. |
| rfflearn.cpu.RFFSVR | Support vector regression with random Fourier features. |
| rfflearn.cpu.RFFBatchSVC | Batch learning version of rfflearn.cpu.RFFSVC. |
| rfflearn.cpu.ORF* | ORF (orthogonal random features) version of estimators. For example, rfflearn.cpu.ORFSVC is a support vector classifier with ORF. The arguments of constructor and member functions are the same as RFF version, so please see the document of rfflearn.cpu.RFF* for the details of the usage of each class. |
| rfflearn.cpu.QRF* | QRF (quasi random features) version of estimators. For example, rfflearn.cpu.QRFSVC is a support vector classifier with QRF. The arguments of constructor and member functions are the same as RFF version, so please see the document of rfflearn.cpu.RFF* for the details of the usage of each class. |
rfflearn.gpu
Sub module for regressors and classifiers of random Fourier feature runnable on GPU. This module is designed to have the same interface as rfflearn.cpu. See the API reference of rfflearn.cpu for the details of this module.
rfflearn.explainer
TBD
rfflearn.tuner
TBD