rcf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce25c6d66fda9444291e34c20c8dabe8b5f8e295de0b75f70df321a09fbc1595
-  data.tar.gz: 8fbaf6473cac28f7a8964a4a4227c1985cbc30b0d2218c36c103bacf0a76f04b
+  metadata.gz: d050fe5e3a88cc6361c5cdb592b558cca82c1c7c35daeb9398db69929d94451d
+  data.tar.gz: 932e1d587efeed620a8f833ab95a2b94a29424430264c11b92cc56e88a86bb3e
 SHA512:
-  metadata.gz: d5e51aeb29db362da886a3159f52e7b8631576993fbd2f4414967f5744c647d5ec31e6a34006032a163b013c858967cf78c7e3dd4a8a895fc2b1dea9738169c9
-  data.tar.gz: a7c0d71a5742bf574e3ea2995507c0f18a2f4caf2463ac5d4a86506073fb56aeb6c5386d47cfb3f0f87bd9ef1339bad238d3b303a8f26ad249ba9517c183d09c
+  metadata.gz: dd55dac9c224b53617af4a91d56c4bcfdd0b1317b03bee93c35fba20798d3d94a1af874ae9a103b32cd53f5418c89c4a7489ae3bd3c8cfce0267a8beb3b9837b
+  data.tar.gz: 3ab0d7a74cf233855b28dcb751c11e77b78efbd88afcfb19e1cfd6533852f3f354db74e06726883bb9dcd3af27b744a6dfe887ace0f60aaca9848ee2d915e7ec

data/CHANGELOG.md

@@ -1,3 +1,7 @@
-## 0.1.0 (unreleased)
+## 0.1.1 (2022-11-06)
+
+- Added support for parameters
+
+## 0.1.0 (2022-11-02)
 
 - First release

data/NOTICE.txt

@@ -0,0 +1,2 @@
+RandomCutForest
+Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.

data/README.md

@@ -51,6 +51,25 @@ forest = Rcf::Forest.new(3)
 end
 ```
 
+## Parameters
+
+Set parameters [unreleased]
+
+```ruby
+Rcf::Forest.new(
+  dimensions,
+  shingle_size: 1,          # shingle size to use
+  sample_size: 256,         # points to keep in sample for each tree
+  number_of_trees: 100,     # number of trees to use in the forest
+  random_seed: 42,          # random seed to use
+  parallel: false           # enable parallel execution
+)
+```
+
+## References
+
+- [Robust Random Cut Forest Based Anomaly Detection On Streams](https://proceedings.mlr.press/v48/guha16.pdf)
+
 ## History
 
 View the [changelog](CHANGELOG.md)

data/lib/rcf/ffi.rb

@@ -11,6 +11,7 @@ module Rcf
     end
 
     extern "rcf_forest *rcf_create(size_t dimensions)"
+    extern "int rcf_set_param(rcf_forest *forest, const char *param, const char *value)"
     extern "void rcf_update(rcf_forest *rcf, const float *point)"
     extern "double rcf_score(rcf_forest *rcf, const float *point)"
     extern "void rcf_free(rcf_forest *rcf)"

data/lib/rcf/forest.rb

@@ -1,10 +1,16 @@
 module Rcf
   class Forest
-    def initialize(dimensions)
+    def initialize(dimensions, shingle_size: 1, sample_size: 256, number_of_trees: 100, random_seed: 42, parallel: false)
       @dimensions = dimensions
-      @pointer = FFI.rcf_create(dimensions)
 
+      @pointer = FFI.rcf_create(dimensions)
       ObjectSpace.define_finalizer(self, self.class.finalize(@pointer))
+
+      set_param("shingle_size", shingle_size)
+      set_param("sample_size", sample_size)
+      set_param("number_of_trees", number_of_trees)
+      set_param("random_seed", random_seed)
+      set_param("parallel", parallel)
     end
 
     def score(point)
@@ -22,6 +28,12 @@ module Rcf
 
     private
 
+    def set_param(param, value)
+      if FFI.rcf_set_param(@pointer, param, value.to_s) != 0
+        raise ArgumentError, "Invalid value for #{param}"
+      end
+    end
+
     def point_ptr(point)
       if point.size != @dimensions
         raise ArgumentError, "Bad size"

data/lib/rcf/version.rb

@@ -1,3 +1,3 @@
 module Rcf
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/vendor/aarch64-linux/NOTICE

@@ -0,0 +1,2 @@
+RandomCutForest
+Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.

data/vendor/aarch64-linux/README.md

@@ -2,15 +2,17 @@
 
 [Random Cut Forest](https://github.com/aws/random-cut-forest-by-aws) (RCF) anomaly detection for C/C++
 
+:evergreen_tree: Also available for [Ruby](https://github.com/ankane/random-cut-forest-ruby) and [PHP](https://github.com/ankane/random-cut-forest-php), and as a [CLI](https://github.com/ankane/rcf-cli)
+
 [![Build Status](https://github.com/ankane/librcf/workflows/build/badge.svg?branch=master)](https://github.com/ankane/librcf/actions)
 
 ## Installation
 
 Download the latest version:
 
-- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-unknown-linux-gnu.tar.gz)
-- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-apple-darwin.tar.gz)
-- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-pc-windows-msvc.zip)
+- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-unknown-linux-gnu.tar.gz)
+- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-apple-darwin.tar.gz)
+- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-pc-windows-msvc.zip)
 
 You can also install it with Homebrew:
 
@@ -32,6 +34,12 @@ Create a forest with 3 dimensions
 rcf_forest *forest = rcf_create(3);
 ```
 
+Set parameters
+
+```c
+rcf_set_param(forest, "number_of_trees", "100");
+```
+
 Score a point
 
 ```c
@@ -65,6 +73,7 @@ float randf() {
 
 int main() {
     rcf_forest *forest = rcf_create(3);
+    rcf_set_param(forest, "number_of_trees", "100");
 
     for (int i = 0; i < 200; i++) {
         float point[] = {randf(), randf(), randf()};
@@ -84,6 +93,28 @@ int main() {
 }
 ```
 
+## Parameters
+
+Name | Description | Default Value
+--- | --- | ---
+`shingle_size` | Shingle size to use | 1
+`sample_size` | Points to keep in sample for each tree | 256
+`number_of_trees` | Number of trees to use in the forest | 100
+`random_seed` | Random seed to use | 42
+`parallel` | Enable parallel execution | false
+
+Parameter values should always be passed as strings.
+
+```c
+rcf_set_param(forest, "parallel", "true");
+```
+
+`rcf_set_param` returns zero if successful and nonzero if the name or value is invalid or if it’s called after `rcf_score` or `rcf_update`.
+
+## Reference
+
+- [Robust Random Cut Forest Based Anomaly Detection On Streams](https://proceedings.mlr.press/v48/guha16.pdf)
+
 ## History
 
 View the [changelog](CHANGELOG.md)

data/vendor/arm64-darwin/NOTICE

@@ -0,0 +1,2 @@
+RandomCutForest
+Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.

data/vendor/arm64-darwin/README.md

@@ -2,15 +2,17 @@
 
 [Random Cut Forest](https://github.com/aws/random-cut-forest-by-aws) (RCF) anomaly detection for C/C++
 
+:evergreen_tree: Also available for [Ruby](https://github.com/ankane/random-cut-forest-ruby) and [PHP](https://github.com/ankane/random-cut-forest-php), and as a [CLI](https://github.com/ankane/rcf-cli)
+
 [![Build Status](https://github.com/ankane/librcf/workflows/build/badge.svg?branch=master)](https://github.com/ankane/librcf/actions)
 
 ## Installation
 
 Download the latest version:
 
-- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-unknown-linux-gnu.tar.gz)
-- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-apple-darwin.tar.gz)
-- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-pc-windows-msvc.zip)
+- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-unknown-linux-gnu.tar.gz)
+- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-apple-darwin.tar.gz)
+- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-pc-windows-msvc.zip)
 
 You can also install it with Homebrew:
 
@@ -32,6 +34,12 @@ Create a forest with 3 dimensions
 rcf_forest *forest = rcf_create(3);
 ```
 
+Set parameters
+
+```c
+rcf_set_param(forest, "number_of_trees", "100");
+```
+
 Score a point
 
 ```c
@@ -65,6 +73,7 @@ float randf() {
 
 int main() {
     rcf_forest *forest = rcf_create(3);
+    rcf_set_param(forest, "number_of_trees", "100");
 
     for (int i = 0; i < 200; i++) {
         float point[] = {randf(), randf(), randf()};
@@ -84,6 +93,28 @@ int main() {
 }
 ```
 
+## Parameters
+
+Name | Description | Default Value
+--- | --- | ---
+`shingle_size` | Shingle size to use | 1
+`sample_size` | Points to keep in sample for each tree | 256
+`number_of_trees` | Number of trees to use in the forest | 100
+`random_seed` | Random seed to use | 42
+`parallel` | Enable parallel execution | false
+
+Parameter values should always be passed as strings.
+
+```c
+rcf_set_param(forest, "parallel", "true");
+```
+
+`rcf_set_param` returns zero if successful and nonzero if the name or value is invalid or if it’s called after `rcf_score` or `rcf_update`.
+
+## Reference
+
+- [Robust Random Cut Forest Based Anomaly Detection On Streams](https://proceedings.mlr.press/v48/guha16.pdf)
+
 ## History
 
 View the [changelog](CHANGELOG.md)

data/vendor/x64-mingw/NOTICE

@@ -0,0 +1,2 @@
+RandomCutForest
+Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.

data/vendor/x64-mingw/README.md

@@ -2,15 +2,17 @@
 
 [Random Cut Forest](https://github.com/aws/random-cut-forest-by-aws) (RCF) anomaly detection for C/C++
 
+:evergreen_tree: Also available for [Ruby](https://github.com/ankane/random-cut-forest-ruby) and [PHP](https://github.com/ankane/random-cut-forest-php), and as a [CLI](https://github.com/ankane/rcf-cli)
+
 [![Build Status](https://github.com/ankane/librcf/workflows/build/badge.svg?branch=master)](https://github.com/ankane/librcf/actions)
 
 ## Installation
 
 Download the latest version:
 
-- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-unknown-linux-gnu.tar.gz)
-- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-apple-darwin.tar.gz)
-- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-pc-windows-msvc.zip)
+- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-unknown-linux-gnu.tar.gz)
+- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-apple-darwin.tar.gz)
+- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-pc-windows-msvc.zip)
 
 You can also install it with Homebrew:
 
@@ -32,6 +34,12 @@ Create a forest with 3 dimensions
 rcf_forest *forest = rcf_create(3);
 ```
 
+Set parameters
+
+```c
+rcf_set_param(forest, "number_of_trees", "100");
+```
+
 Score a point
 
 ```c
@@ -65,6 +73,7 @@ float randf() {
 
 int main() {
     rcf_forest *forest = rcf_create(3);
+    rcf_set_param(forest, "number_of_trees", "100");
 
     for (int i = 0; i < 200; i++) {
         float point[] = {randf(), randf(), randf()};
@@ -84,6 +93,28 @@ int main() {
 }
 ```
 
+## Parameters
+
+Name | Description | Default Value
+--- | --- | ---
+`shingle_size` | Shingle size to use | 1
+`sample_size` | Points to keep in sample for each tree | 256
+`number_of_trees` | Number of trees to use in the forest | 100
+`random_seed` | Random seed to use | 42
+`parallel` | Enable parallel execution | false
+
+Parameter values should always be passed as strings.
+
+```c
+rcf_set_param(forest, "parallel", "true");
+```
+
+`rcf_set_param` returns zero if successful and nonzero if the name or value is invalid or if it’s called after `rcf_score` or `rcf_update`.
+
+## References
+
+- [Robust Random Cut Forest Based Anomaly Detection On Streams](https://proceedings.mlr.press/v48/guha16.pdf)
+
 ## History
 
 View the [changelog](CHANGELOG.md)

data/vendor/x86_64-darwin/NOTICE

@@ -0,0 +1,2 @@
+RandomCutForest
+Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.

data/vendor/x86_64-darwin/README.md

@@ -2,15 +2,17 @@
 
 [Random Cut Forest](https://github.com/aws/random-cut-forest-by-aws) (RCF) anomaly detection for C/C++
 
+:evergreen_tree: Also available for [Ruby](https://github.com/ankane/random-cut-forest-ruby) and [PHP](https://github.com/ankane/random-cut-forest-php), and as a [CLI](https://github.com/ankane/rcf-cli)
+
 [![Build Status](https://github.com/ankane/librcf/workflows/build/badge.svg?branch=master)](https://github.com/ankane/librcf/actions)
 
 ## Installation
 
 Download the latest version:
 
-- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-unknown-linux-gnu.tar.gz)
-- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-aarch64-apple-darwin.tar.gz)
-- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.0/librcf-0.1.0-x86_64-pc-windows-msvc.zip)
+- Linux - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-unknown-linux-gnu.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-unknown-linux-gnu.tar.gz)
+- Mac - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-apple-darwin.tar.gz) or [arm64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-aarch64-apple-darwin.tar.gz)
+- Windows - [x86_64](https://github.com/ankane/librcf/releases/download/v0.1.1/librcf-0.1.1-x86_64-pc-windows-msvc.zip)
 
 You can also install it with Homebrew:
 
@@ -32,6 +34,12 @@ Create a forest with 3 dimensions
 rcf_forest *forest = rcf_create(3);
 ```
 
+Set parameters
+
+```c
+rcf_set_param(forest, "number_of_trees", "100");
+```
+
 Score a point
 
 ```c
@@ -65,6 +73,7 @@ float randf() {
 
 int main() {
     rcf_forest *forest = rcf_create(3);
+    rcf_set_param(forest, "number_of_trees", "100");
 
     for (int i = 0; i < 200; i++) {
         float point[] = {randf(), randf(), randf()};
@@ -84,6 +93,28 @@ int main() {
 }
 ```
 
+## Parameters
+
+Name | Description | Default Value
+--- | --- | ---
+`shingle_size` | Shingle size to use | 1
+`sample_size` | Points to keep in sample for each tree | 256
+`number_of_trees` | Number of trees to use in the forest | 100
+`random_seed` | Random seed to use | 42
+`parallel` | Enable parallel execution | false
+
+Parameter values should always be passed as strings.
+
+```c
+rcf_set_param(forest, "parallel", "true");
+```
+
+`rcf_set_param` returns zero if successful and nonzero if the name or value is invalid or if it’s called after `rcf_score` or `rcf_update`.
+
+## Reference
+
+- [Robust Random Cut Forest Based Anomaly Detection On Streams](https://proceedings.mlr.press/v48/guha16.pdf)
+
 ## History
 
 View the [changelog](CHANGELOG.md)