php-ml/README.md

42 lines
1.5 KiB
Markdown
Raw Normal View History

2016-04-08 22:50:08 +00:00
# PHP Machine Learning library
2016-02-08 22:07:16 +00:00
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-04-08 21:22:55 +00:00
Fresh approach to machine learning in PHP. Note that at the moment PHP is not the best choice for machine learning but maybe this will change ...
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
## To-Do
* implements more algorithms
* integration with Lavacharts for data visualization
## Testing
2016-04-08 21:22:55 +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-04-08 21:22:55 +00:00
Arkadiusz Kondas (@ArkadiuszKondas)