php-ml/README.md

102 lines
4.9 KiB
Markdown
Raw Normal View History

2016-05-03 11:08:09 +00:00
# PHP-ML - Machine Learning library for PHP
2016-02-08 22:07:16 +00:00
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.0-8892BF.svg)](https://php.net/)
[![Latest Stable Version](https://img.shields.io/packagist/v/php-ai/php-ml.svg)](https://packagist.org/packages/php-ai/php-ml)
2016-04-08 21:22:55 +00:00
[![Build Status](https://scrutinizer-ci.com/g/php-ai/php-ml/badges/build.png?b=develop)](https://scrutinizer-ci.com/g/php-ai/php-ml/build-status/develop)
2016-04-08 22:50:08 +00:00
[![Documentation Status](https://readthedocs.org/projects/php-ml/badge/?version=develop)](http://php-ml.readthedocs.org/en/develop/?badge=develop)
2016-04-08 21:22:55 +00:00
[![Total Downloads](https://poser.pugx.org/php-ai/php-ml/downloads.svg)](https://packagist.org/packages/php-ai/php-ml)
[![License](https://poser.pugx.org/php-ai/php-ml/license.svg)](https://packagist.org/packages/php-ai/php-ml)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/php-ai/php-ml/badges/quality-score.png?b=develop)](https://scrutinizer-ci.com/g/php-ai/php-ml/?branch=develop)
2016-02-08 22:07:16 +00:00
2016-07-16 22:31:47 +00:00
![PHP-ML - Machine Learning library for PHP](docs/assets/php-ml-logo.png)
2016-06-15 14:04:09 +00:00
Fresh approach to Machine Learning in PHP. Algorithms, Cross Validation, Preprocessing, Feature Extraction and much more in one library.
2016-05-02 10:07:53 +00:00
PHP-ML requires PHP >= 7.0.
2016-05-02 10:07:53 +00:00
Simple example of classification:
```php
2016-05-02 12:10:49 +00:00
use Phpml\Classification\KNearestNeighbors;
2016-05-02 10:07:53 +00:00
$samples = [[1, 3], [1, 4], [2, 4], [3, 1], [4, 1], [4, 2]];
$labels = ['a', 'a', 'a', 'b', 'b', 'b'];
$classifier = new KNearestNeighbors();
$classifier->train($samples, $labels);
$classifier->predict([3, 2]);
// return 'b'
```
2016-02-08 22:07:16 +00:00
2016-04-08 21:22:55 +00:00
## Documentation
2016-02-08 22:20:08 +00:00
2016-04-08 22:53:18 +00:00
To find out how to use PHP-ML follow [Documentation](http://php-ml.readthedocs.org/).
2016-02-08 22:07:16 +00:00
## Installation
2016-04-08 21:22:55 +00:00
Currently this library is in the process of developing, but You can install it with Composer:
```
composer require php-ai/php-ml
```
2016-02-08 22:07:16 +00:00
2016-05-02 10:07:53 +00:00
## Features
* Classification
2016-05-07 21:53:42 +00:00
* [SVC](http://php-ml.readthedocs.io/en/latest/machine-learning/classification/svc/)
2016-05-02 11:49:19 +00:00
* [k-Nearest Neighbors](http://php-ml.readthedocs.io/en/latest/machine-learning/classification/k-nearest-neighbors/)
* [Naive Bayes](http://php-ml.readthedocs.io/en/latest/machine-learning/classification/naive-bayes/)
2016-05-02 10:07:53 +00:00
* Regression
2016-05-02 11:49:19 +00:00
* [Least Squares](http://php-ml.readthedocs.io/en/latest/machine-learning/regression/least-squares/)
2016-05-07 21:53:42 +00:00
* [SVR](http://php-ml.readthedocs.io/en/latest/machine-learning/regression/svr/)
2016-05-02 10:07:53 +00:00
* Clustering
2016-05-14 19:50:48 +00:00
* [k-Means](http://php-ml.readthedocs.io/en/latest/machine-learning/clustering/k-means/)
* [DBSCAN](http://php-ml.readthedocs.io/en/latest/machine-learning/clustering/dbscan/)
* Metric
* [Accuracy](http://php-ml.readthedocs.io/en/latest/machine-learning/metric/accuracy/)
2016-07-11 22:11:18 +00:00
* [Confusion Matrix](http://php-ml.readthedocs.io/en/latest/machine-learning/metric/confusion-matrix/)
2016-07-19 20:17:03 +00:00
* [Classification Report](http://php-ml.readthedocs.io/en/latest/machine-learning/metric/classification-report/)
2016-07-11 22:00:17 +00:00
* Workflow
* [Pipeline](http://php-ml.readthedocs.io/en/latest/machine-learning/workflow/pipeline)
2016-05-02 10:07:53 +00:00
* Cross Validation
2016-05-14 19:50:48 +00:00
* [Random Split](http://php-ml.readthedocs.io/en/latest/machine-learning/cross-validation/random-split/)
2016-07-10 22:07:07 +00:00
* [Stratified Random Split](http://php-ml.readthedocs.io/en/latest/machine-learning/cross-validation/stratified-random-split/)
2016-05-09 21:52:09 +00:00
* Preprocessing
2016-05-14 19:50:48 +00:00
* [Normalization](http://php-ml.readthedocs.io/en/latest/machine-learning/preprocessing/normalization/)
* [Imputation missing values](http://php-ml.readthedocs.io/en/latest/machine-learning/preprocessing/imputation-missing-values/)
2016-05-07 21:53:42 +00:00
* Feature Extraction
2016-05-14 19:50:48 +00:00
* [Token Count Vectorizer](http://php-ml.readthedocs.io/en/latest/machine-learning/feature-extraction/token-count-vectorizer/)
2016-07-11 22:21:34 +00:00
* [Tf-idf Transformer](http://php-ml.readthedocs.io/en/latest/machine-learning/feature-extraction/tf-idf-transformer/)
2016-05-02 11:49:19 +00:00
* Datasets
* [Array](http://php-ml.readthedocs.io/en/latest/machine-learning/datasets/array-dataset/)
2016-05-14 19:50:48 +00:00
* [CSV](http://php-ml.readthedocs.io/en/latest/machine-learning/datasets/csv-dataset/)
* [Files](http://php-ml.readthedocs.io/en/latest/machine-learning/datasets/files-dataset/)
2016-05-02 11:49:19 +00:00
* Ready to use:
* [Iris](http://php-ml.readthedocs.io/en/latest/machine-learning/datasets/demo/iris/)
2016-05-10 21:44:28 +00:00
* [Wine](http://php-ml.readthedocs.io/en/latest/machine-learning/datasets/demo/wine/)
* [Glass](http://php-ml.readthedocs.io/en/latest/machine-learning/datasets/demo/glass/)
2016-05-02 11:49:19 +00:00
* Math
* [Distance](http://php-ml.readthedocs.io/en/latest/math/distance/)
* [Matrix](http://php-ml.readthedocs.io/en/latest/math/matrix/)
2016-05-09 21:52:09 +00:00
* [Statistic](http://php-ml.readthedocs.io/en/latest/math/statistic/)
2016-05-02 11:49:19 +00:00
2016-02-08 22:07:16 +00:00
2016-05-02 10:07:53 +00:00
## Contribute
2016-02-08 22:07:16 +00:00
2016-05-02 10:07:53 +00:00
- Issue Tracker: github.com/php-ai/php-ml/issues
- Source Code: github.com/php-ai/php-ml
2016-02-08 22:07:16 +00:00
2016-05-02 10:07:53 +00:00
After installation, you can launch the test suite in project root directory (you will need to install dev requirements with Composer)
2016-02-08 22:07:16 +00:00
```
bin/phpunit
```
## License
PHP-ML is released under the MIT Licence. See the bundled LICENSE file for details.
## Author
2016-05-02 10:07:53 +00:00
Arkadiusz Kondas (@ArkadiuszKondas)