README.md in isotree-0.2.2 vs README.md in isotree-0.3.0
- old
+ new
@@ -14,19 +14,22 @@
```ruby
gem "isotree"
```
+Windows is not supported at the moment
+
## Getting Started
Prep your data
```ruby
data = [
{department: "Books", sale: false, price: 2.50},
{department: "Books", sale: true, price: 3.00},
- {department: "Movies", sale: false, price: 5.00}
+ {department: "Movies", sale: false, price: 5.00},
+ # ...
]
```
Train a model
@@ -59,32 +62,42 @@
Pass parameters - default values below
```ruby
IsoTree::IsolationForest.new(
- sample_size: nil,
+ sample_size: "auto",
ntrees: 500,
ndim: 3,
- ntry: 3,
- prob_pick_avg_gain: 0,
- prob_pick_pooled_gain: 0,
- prob_split_avg_gain: 0,
- prob_split_pooled_gain: 0,
- min_gain: 0,
- missing_action: "impute",
- new_categ_action: "smallest",
- categ_split_type: "subset",
+ ntry: 1,
+ max_depth: "auto",
+ ncols_per_tree: nil,
+ prob_pick_pooled_gain: 0.0,
+ prob_pick_avg_gain: 0.0,
+ prob_pick_full_gain: 0.0,
+ prob_pick_dens: 0.0,
+ prob_pick_col_by_range: 0.0,
+ prob_pick_col_by_var: 0.0,
+ prob_pick_col_by_kurt: 0.0,
+ min_gain: 0.0,
+ missing_action: "auto",
+ new_categ_action: "auto",
+ categ_split_type: "auto",
all_perm: false,
coef_by_prop: false,
sample_with_replacement: false,
- penalize_range: true,
+ penalize_range: false,
+ standardize_data: true,
+ scoring_metric: "depth",
+ fast_bratio: true,
weigh_by_kurtosis: false,
- coefs: "normal",
+ coefs: "uniform",
+ assume_full_distr: true,
min_imp_obs: 3,
depth_imp: "higher",
weigh_imp_rows: "inverse",
random_seed: 1,
+ use_long_double: false,
nthreads: -1
)
```
See a [detailed explanation](https://isotree.readthedocs.io/en/latest/#isotree.IsolationForest)
@@ -132,19 +145,24 @@
Check out [Trove](https://github.com/ankane/trove) for deploying models.
```sh
trove push model.bin
-trove push model.bin.metadata
```
## Reference
Get the average isolation depth
```ruby
model.predict(data, output: "avg_depth")
```
+
+## Upgrading
+
+### 0.3.0
+
+This version uses IsoTree’s new serialization format. Exported models must be recreated.
## History
View the [changelog](https://github.com/ankane/isotree-ruby/blob/master/CHANGELOG.md)