hunch 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a696037fbdde4271f78d6791bf6cc78bb63a40eff67826a95c2824bcc6a11b09
-  data.tar.gz: 62156178770fd54095e2305b75589fec4912a16be951128dcad6f0b240a63014
+  metadata.gz: 385258ecd737c836bd9b677e023cbc5ffc653770ee046aba43aeeac3225c8cc2
+  data.tar.gz: 335bd7011b904736715d5490ca56645ce9a012faf7aff0fd485929d8ec5e5cf3
 SHA512:
-  metadata.gz: 9a893724840f3e4eeef9fafcbd5ccacff3ed94496d7c4043e6b78a730f4026df44ff4bf71b37cba09ad977de4eba98192cc01a631ffc9c0c9c5a806e633793c4
-  data.tar.gz: 93d6892320b259b9021dd8c3f97552d3ea0b06778350c415122f38565bb4904e0d5184a89928f1091e4f82cdbe482a4081bc772af752719805c0080ecaf3dbf9
+  metadata.gz: 05473ca9fbca95957fecd251d2dc53ee239f5e12b4b579846dbccf20c92f78a36ee0d4697b5a410ef89ddf406829e85bcead5aa0361307e32a3eb97984f9fd98
+  data.tar.gz: 9e50657e98f6e290fe96f08e161416ead241aae674dad5a9862c38eaac60232fc3fb314f60ae0cbee342f3d51b71fa2e5d8a0ce7cfb2eaaafa9411cb3fb08ca0

data/README.md

@@ -7,7 +7,7 @@ three moves for judgment calls. Every question is a conditional probability —
 _how likely is this, given that_ — and the API reads that way:
 
 ```ruby
-if Hunch.almost_certain?("this order is fraudulent", given: order.attributes)
+if Hunch.almost_certainly?("this order is fraudulent", given: order.attributes)
   order.hold!
 end
 ```
@@ -40,15 +40,18 @@ Hunch.chance("written by a real human, not spam", given: bio)  # => 0.87
 Named levels collapse it into predicates:
 
 ```ruby
-Hunch.possible?("fraudulent", given: order)        # chance >= 0.25
-Hunch.likely?("fraudulent", given: order)          # chance >= 0.5
-Hunch.probable?("fraudulent", given: order)        # chance >= 0.75
-Hunch.almost_certain?("fraudulent", given: order)  # chance >= 0.93
+Hunch.possibly?("fraudulent", given: order)         # chance >= 0.25
+Hunch.likely?("fraudulent", given: order)           # chance >= 0.5
+Hunch.probably?("fraudulent", given: order)         # chance >= 0.75
+Hunch.almost_certainly?("fraudulent", given: order) # chance >= 0.93
 
 Hunch.configure { |c| c.levels[:paranoid] = 0.99 }
 Hunch.paranoid?("fraudulent", given: order)        # chance >= 0.99
 ```
 
+Configure built-in thresholds with the matching level names, for example
+`Hunch.configure { |c| c.levels[:probably] = 0.8 }`.
+
 **`pick`** answers _which_:
 
 ```ruby
@@ -77,13 +80,13 @@ Several questions about one piece of state cost one API call:
 
 ```ruby
 result = Hunch.decide(given: mail.raw_source) do |q|
-  q.probable? :urgent, "does this convey urgency?"
+  q.probably? :urgent, "does this convey urgency?"
   q.pick      :team, billing: "payments", technical: "bugs", sales: "pricing"
   q.rate      :mood, :calm, :frustrated, :livid
 end
 
 result.urgent             # => 0.92
-result.urgent?            # => true, past :probable
+result.urgent?            # => true, at or above :probably
 result.team               # => :technical
 result.team_probabilities # => { billing: 0.08, technical: 0.85, sales: 0.07 }
 result.mood.level         # => :livid
@@ -117,7 +120,7 @@ class Signup < ApplicationRecord
 
   def bio_reads_like_a_human
     return if bio.blank?
-    return if Hunch.probable?("a genuine human bio, not spam or keyword stuffing", given: bio)
+    return if Hunch.probably?("a genuine human bio, not spam or keyword stuffing", given: bio)
 
     errors.add(:bio, "reads like spam")
   rescue Hunch::APIError

data/lib/hunch/backends/stub.rb

@@ -39,7 +39,7 @@ module Hunch
           when true then 1.0
           when false then 0.0
           when Numeric then value.to_f
-          else raise ArgumentError, "noul stub must be true, false, or a probability"
+          else raise ArgumentError, "chance stub must be true, false, or a probability"
           end
         { "type" => "noul", "noul" => probability }
       end
@@ -49,7 +49,7 @@ module Hunch
           case value
           when Symbol then question.options.keys.to_h { |option| [option.to_s, option == value ? 1.0 : 0.0] }
           when Hash then value.transform_keys(&:to_s).transform_values(&:to_f)
-          else raise ArgumentError, "choice stub must be a symbol or a probabilities hash"
+          else raise ArgumentError, "pick stub must be a symbol or a probabilities hash"
           end
         winner = probabilities.max_by { |_, p| p }.first
         { "type" => "choice", "choice" => winner, "probabilities" => probabilities, "confidence" => probabilities[winner] }

data/lib/hunch/configuration.rb

@@ -1,6 +1,6 @@
 module Hunch
   class Configuration
-    LEVELS = { possible: 0.25, likely: 0.5, probable: 0.75, almost_certain: 0.93 }.freeze
+    LEVELS = { possibly: 0.25, likely: 0.5, probably: 0.75, almost_certainly: 0.93 }.freeze
 
     attr_accessor :api_key, :model, :url, :timeout, :open_timeout, :max_retries, :levels
     attr_writer :backend
@@ -24,7 +24,7 @@ module Hunch
           raise ConfigurationError, "unknown level #{value.inspect}; known levels: #{levels.keys.join(", ")}"
         end
       else
-        raise ArgumentError, "at_least must be a number or a level name"
+        raise ArgumentError, "level must be a number or a level name"
       end
     end
 

data/lib/hunch/version.rb

@@ -1,3 +1,3 @@
 module Hunch
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hunch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Carl Dawson
@@ -9,7 +9,7 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: 'likely?, pick, and score: three primitives that let Ruby branch on judgment
+description: 'chance, pick, and rate: three primitives that let Ruby branch on judgment
   calls, answered by TypeSafe''s Jev System One model or any backend you plug in.'
 email:
 - carldawson@hey.com