create some text in readme

This commit is contained in:
Arkadiusz Kondas 2016-02-08 23:07:16 +01:00
parent 2d78110b39
commit 501c020f67
4 changed files with 44 additions and 5 deletions

View File

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2016 php-ai
Copyright (c) 2016 Arkadiusz Kondas <arkadiusz.kondas[at]gmail>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@ -1,2 +1,33 @@
# php-ml
PHP Machine learning library
# PHP Machine learning library
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 ...
## Available Algorithms
### Classification
* **Naive Bayes** - a set of supervised learning algorithms based on applying Bayes theorem with the “naive” assumption of independence between every pair of features
## Installation
This repo will be published do packagist.org soon...
## To-Do
* implements more algorithms
* integration with Lavacharts for data visualization
## Testing
After installation, you can launch the test suite in project root directory (you will need to install dev requiremnts with composer)
```
bin/phpunit
```
## License
PHP-ML is released under the MIT Licence. See the bundled LICENSE file for details.
## Author

View File

@ -1,14 +1,22 @@
{
"name": "php-ai/php-ml",
"type": "library",
"description": "PHP Machine learning library",
"license": "MIT",
"keywords": ["machine learning","pattern recognition","computational learning theory","artificial intelligence"],
"homepage": "https://github.com/php-ai/php-ml",
"authors": [
{
"name": "Arkadiusz Kondas",
"email": "arkadiusz.kondas@gmail.com"
}
],
"require": {},
"config": {
"bin-dir": "bin"
},
"require": {
"php": ">=5.5.0"
},
"require-dev": {
"phpunit/phpunit": "^5.2"
}

2
composer.lock generated
View File

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically"
],
"hash": "a41cb755c408a5d0b23d76a8a54a3054",
"hash": "640f762012a359b150ce245491743448",
"content-hash": "5efa8db5a672e2128d20c80c18746c72",
"packages": [],
"packages-dev": [