README.md in xlearn-0.1.2 vs README.md in xlearn-0.1.3
- old
+ new
@@ -80,16 +80,33 @@
model.latent_factors # fm and ffm only
```
## Parameters
-Specify parameters
+Pass parameters - default values below
```ruby
-model = XLearn::Linear.new(k: 20, epoch: 50)
+XLearn::FM.new(
+ task: "binary", # binary (classification), reg (regression)
+ metric: nil, # acc, prec, recall, f1, auc, mae, mape, rmse, rmsd
+ lr: 0.2, # learning rate
+ lambda: 0.00002, # lambda for l2 regularization
+ k: 4, # latent factors for fm and ffm
+ alpha: 0.3, # hyper parameter for ftrl
+ beta: 1.0, # hyper parameter for ftrl
+ lambda_1: 0.00001, # hyper parameter for ftrl
+ lambda_2: 0.00002, # hyper parameter for ftrl
+ epoch: 10, # number of epochs
+ fold: 3, # number of folds
+ opt: "adagrad", # sgd, adagrad, ftrl
+ block_size: 500, # block size for on-disk training in MB
+ early_stop: true, # use early stopping
+ stop_window: 2, # size of stop window for early stopping
+ sign: false, # convert predition output to 0 and 1
+ sigmoid: false, # convert predition output using sigmoid
+ seed: 1 # random seed to shuffle data set
+)
```
-
-Supports the same parameters as [Python](https://xlearn-doc.readthedocs.io/en/latest/all_api/index.html)
## Cross-Validation
Cross-validation