README.md in xlearn-0.1.1 vs README.md in xlearn-0.1.2
- old
+ new
@@ -1,23 +1,19 @@
# xLearn
[xLearn](https://github.com/aksnzhy/xlearn) - the high performance machine learning library - for Ruby
-:fire: Uses the C API for blazing performance
-
Supports:
- Linear models
- Factorization machines
- Field-aware factorization machines
[](https://travis-ci.org/ankane/xlearn)
## Installation
-First, [install xLearn](https://xlearn-doc.readthedocs.io/en/latest/install/index.html). On Mac, copy `build/lib/libxlearn_api.dylib` to `/usr/local/lib`.
-
Add this line to your application’s Gemfile:
```ruby
gem 'xlearn'
```
@@ -164,28 +160,10 @@
```ruby
model.predict("test.txt", out_path: "predictions.txt")
```
-## xLearn Installation
-
-There’s an experimental branch that includes xLearn with the gem for easiest installation.
-
-```ruby
-gem 'xlearn', github: 'ankane/xlearn', branch: 'vendor', submodules: true
-```
-
-Please file an issue if it doesn’t work for you.
-
-You can also specify the path to xLearn in an initializer:
-
-```ruby
-XLearn.ffi_lib << "/path/to/xlearn/lib/libxlearn_api.so"
-```
-
-> Use `libxlearn_api.dylib` for Mac and `xlearn_api.dll` for Windows
-
## Credits
This library is modeled after xLearn’s [Scikit-learn API](https://xlearn-doc.readthedocs.io/en/latest/python_api/index.html).
## History
@@ -198,5 +176,15 @@
- [Report bugs](https://github.com/ankane/xlearn/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/xlearn/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/xlearn.git
+cd xlearn
+bundle install
+bundle exec rake vendor:all
+bundle exec rake test
+```