beauvoir 0.0.2b → 0.0.2c

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d08d58653a1e5586213426ba0026787bb0c9d5c6
-  data.tar.gz: 65f2d360cec83211db9809f6025195f243737720
+  metadata.gz: 9f58dceb149ae08f0e1ce66318423fd316a1b4f9
+  data.tar.gz: 5c1ceaeaee4f6f437b6afaa460c63e0415e1dfa1
 SHA512:
-  metadata.gz: 495d9a48b07c37cb9110f4787cc75b8c4b9bc79089c34e493d541f09514223708ffabb995d199e9fd786b7a03307f0f3e73616e5a0e691609cab1c42563c8b7e
-  data.tar.gz: 189b378c9f7eacee1acaf206a60d975fd9f1c4108eb2b8cbad53a4535c7154f74a6398fea2ae2f66a0f2f1a90466170b6bd147d3e7e654d220fc10208b24be7b
+  metadata.gz: 34ca58e2b539d7ed9b5e1be9a6a3470681e537f57a69a554d82e0affad33030e9574c985a13ef55dc0a9ee19e301df25f192de56668030635002fddcb44c6a12
+  data.tar.gz: f4206f47ecc7dccb2dfdc05b910fbdf2d5b8cb41eeb12caee87bd13d27e845e901204c590c421e01ed2c8205bd81559be6c09878fbc8a441a52bf40cdb4e278e

data/README.md

@@ -12,9 +12,9 @@ This is pre-alpha software. The API will change, I guarantee it.
 Caveats
 -------
 
-It's important to note that many people identify as neither a men nor a women. It's important, too, to note that many people who do identify as male or female have names that are held by far more people who identify as another gender. All of these people deserve not to be misgendered.
+It's important to note that many people identify as neither a men nor a women. It's important, too, to note that many people who do identify as male or female have names for which most other people with that name identify as a different gender. All of these people deserve not to be misgendered.
 
-Nevertheless, automatically classifying people by apparent gender can be a very useful tool to perform censuses of communities or publications to detect and quantify perhaps-invisible bias. VIDA is a pioneer in this field, but their \"Count\" is limited by a manual methodology that depends hundreds of person-hours of labor. There is a place for more automated counts and Beauvoir can help, but if you plan to publish a count like this, you should be careful. You should probably set very high confidence thresholds to make sure you're very unlikely to misgender someone; you should also be prepared to be responsive and respectful if you do. You should include your methodology, prominently. You might consider emphasizing aggregate numbers over your mapping of individual people's names to genders.
+Nevertheless, automatically classifying people by apparent gender can be a very useful tool to perform censuses of communities or publications to detect and quantify perhaps-invisible bias. VIDA is a pioneer in performing theses censuses, but their \"Count\" is limited by a manual methodology that depends hundreds of person-hours of labor. There is a place for more automated counts and Beauvoir can help, but if you plan to publish a count like this, you should be careful. Beauvoir's confidence thresholds are set very high by default on purpose, you shouldn't lower them unless you take other steps to make sure that you're very unlikely to misgender someone; you should also be prepared to be responsive and respectful if you do. You should include your methodology, prominently. You might consider emphasizing aggregate numbers over your mapping of individual people's names to genders.
 
 Usage
 -----
@@ -31,9 +31,9 @@ b.guess("Mary")
 b.guess("Sam")
 => :unknown
 
-b.femaleness_ratio("Sam")
+b.estimated_female_value("Sam")
 => 0.0103360994972961
-b.maleness_ratio("Sam")
+b.estimated_male_value("Sam")
 => 0.9896639005027039
 ````
 
@@ -50,10 +50,10 @@ b.guess("Sam")
 => :male
 
 #the same as above
-b.femaleness_ratio("Sam")
-=> 0.010336099497296115
-b.maleness_ratio("Sam")
-=> 0.9896639005027039
+b.estimated_female_value("Sam")
+=> 0.01034936186847522
+b.estimated_male_value("Sam")
+=> 0.9896506381315247
 ````
 
 Methodology

data/lib/beauvoir.rb

@@ -112,4 +112,12 @@ class Beauvoir
       nil
     end
   end
+
+  def inspect
+    inspect_string = "#<#{self.class.name}:0x#{(self.object_id*2).to_s(16)} "
+    exclude = [:@names_by_names, :@names_genders]
+    fields = self.instance_variables - exclude
+    inspect_string << fields.map{|field| "#{field}=#{instance_variable_get(field)}"}.join(", ") << ">"
+    inspect_string
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beauvoir
 version: !ruby/object:Gem::Version
-  version: 0.0.2b
+  version: 0.0.2c
 platform: ruby
 authors:
 - Jeremy B. Merrill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-26 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies: []
 description: "Guess gender by a first name using more detailed, better\n                    sourced
   data from Open Gender Tracker's Global Name Data.<br />\n                    Beauvoir