rcf 0.1.0 → 0.1.2

data/vendor/x86_64-linux/NOTICE

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

data/vendor/x86_64-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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rcf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-03 00:00:00.000000000 Z
+date: 2023-06-08 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -18,30 +18,36 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE.txt
+- NOTICE.txt
 - README.md
 - lib/rcf.rb
 - lib/rcf/ffi.rb
 - lib/rcf/forest.rb
 - lib/rcf/version.rb
 - vendor/aarch64-linux/LICENSE
+- vendor/aarch64-linux/LICENSE-THIRD-PARTY
+- vendor/aarch64-linux/NOTICE
 - vendor/aarch64-linux/README.md
-- vendor/aarch64-linux/THIRD-PARTY-LICENSES
 - vendor/aarch64-linux/lib/librcf.so
 - vendor/arm64-darwin/LICENSE
+- vendor/arm64-darwin/LICENSE-THIRD-PARTY
+- vendor/arm64-darwin/NOTICE
 - vendor/arm64-darwin/README.md
-- vendor/arm64-darwin/THIRD-PARTY-LICENSES
 - vendor/arm64-darwin/lib/librcf.dylib
 - vendor/x64-mingw/LICENSE
+- vendor/x64-mingw/LICENSE-THIRD-PARTY
+- vendor/x64-mingw/NOTICE
 - vendor/x64-mingw/README.md
-- vendor/x64-mingw/THIRD-PARTY-LICENSES
 - vendor/x64-mingw/lib/rcf.dll
 - vendor/x86_64-darwin/LICENSE
+- vendor/x86_64-darwin/LICENSE-THIRD-PARTY
+- vendor/x86_64-darwin/NOTICE
 - vendor/x86_64-darwin/README.md
-- vendor/x86_64-darwin/THIRD-PARTY-LICENSES
 - vendor/x86_64-darwin/lib/librcf.dylib
 - vendor/x86_64-linux/LICENSE
+- vendor/x86_64-linux/LICENSE-THIRD-PARTY
+- vendor/x86_64-linux/NOTICE
 - vendor/x86_64-linux/README.md
-- vendor/x86_64-linux/THIRD-PARTY-LICENSES
 - vendor/x86_64-linux/lib/librcf.so
 homepage: https://github.com/ankane/random-cut-forest-ruby
 licenses:
@@ -62,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Random Cut Forest anomaly detection for Ruby