From 501c020f67e1b4fd572fc0b73b33a3b21d4158fa Mon Sep 17 00:00:00 2001 From: Arkadiusz Kondas Date: Mon, 8 Feb 2016 23:07:16 +0100 Subject: [PATCH] create some text in readme --- LICENSE | 2 +- README.md | 35 +++++++++++++++++++++++++++++++++-- composer.json | 10 +++++++++- composer.lock | 2 +- 4 files changed, 44 insertions(+), 5 deletions(-) diff --git a/LICENSE b/LICENSE index ebb92df..bd5cb2f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016 php-ai +Copyright (c) 2016 Arkadiusz Kondas Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 416323b..2d454a5 100644 --- a/README.md +++ b/README.md @@ -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 + diff --git a/composer.json b/composer.json index 8e85eed..7f6a744 100644 --- a/composer.json +++ b/composer.json @@ -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" } diff --git a/composer.lock b/composer.lock index e697bf5..1117546 100644 --- a/composer.lock +++ b/composer.lock @@ -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": [