Skip to content

Commit

Permalink
create some text in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akondas committed Feb 8, 2016
1 parent 2d78110 commit 501c020
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 5 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

10 changes: 9 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -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": "[email protected]"
}
],
"require": {},
"config": {
"bin-dir": "bin"
},
"require": {
"php": ">=5.5.0"
},
"require-dev": {
"phpunit/phpunit": "^5.2"
}
Expand Down
2 changes: 1 addition & 1 deletion composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 501c020

Please sign in to comment.