README.md in eps-0.3.3 vs README.md in eps-0.3.4

- old
+ new

@@ -2,11 +2,10 @@ Machine learning for Ruby - Build predictive models quickly and easily - Serve models built in Ruby, Python, R, and more -- No prior knowledge of machine learning required :tada: Check out [this post](https://ankane.org/rails-meet-data-science) for more info on machine learning with Rails [![Build Status](https://travis-ci.org/ankane/eps.svg?branch=master)](https://travis-ci.org/ankane/eps) @@ -377,10 +376,20 @@ ```ruby Eps::Model.new(data, intercept: false) ``` +## Probability + +To get the probability of each category for predictions with classification, use: + +```ruby +model.predict_probability(data) +``` + +Naive Bayes is known to produce poor probability estimates, so stick with LightGBM if you need this. + ## Validation Options Pass your own validation set with: ```ruby @@ -412,11 +421,11 @@ > We recommend adding monitoring and guardrails as well if you retrain automatically Create an ActiveRecord model to store the predictive model. ```sh -rails g model Model key:string:uniq data:text +rails generate model Model key:string:uniq data:text ``` Store the model with: ```ruby @@ -522,13 +531,13 @@ - [Report bugs](https://github.com/ankane/eps/issues) - Fix bugs and [submit pull requests](https://github.com/ankane/eps/pulls) - Write, clarify, or fix documentation - Suggest or add new features -To get started with development and testing: +To get started with development: ```sh git clone https://github.com/ankane/eps.git cd eps bundle install -rake test +bundle exec rake test ```