README.md in ngt-0.2.3 vs README.md in ngt-0.2.4
- old
+ new
@@ -10,11 +10,11 @@
```ruby
gem 'ngt'
```
-NGT is not available for Windows yet
+NGT is not available for Windows
## Getting Started
Prep your data
@@ -82,11 +82,12 @@
Optimize the index
```ruby
optimizer = Ngt::Optimizer.new(outgoing: 10, incoming: 120)
-optimizer.execute(path, new_path)
+optimizer.adjust_search_coefficients(index)
+optimizer.execute(index, new_path)
```
## Full Example
```ruby
@@ -104,9 +105,41 @@
result.each do |res|
puts "#{res[:id]}, #{res[:distance]}"
p index.object(res[:id])
end
+```
+
+## Index Options
+
+Defaults shown below
+
+```ruby
+Ngt::Index.new(dimensions,
+ edge_size_for_creation: 10,
+ edge_size_for_search: 40,
+ object_type: :float, # :float, :integer
+ distance_type: :l2, # :l1, :l2, :hamming, :angle, :cosine, or :jaccard
+ path: nil
+)
+```
+
+## Optimizer Options
+
+Defaults shown below
+
+```ruby
+Ngt::Optimizer.new(
+ outgoing: 10,
+ incoming: 120,
+ queries: 100,
+ low_accuracy_from: 0.3,
+ low_accuracy_to: 0.5,
+ high_accuracy_from: 0.8,
+ high_accuracy_to: 0.9,
+ gt_epsilon: 0.1,
+ merge: 0.2
+)
```
## Data
Data can be an array of arrays