genderize

v0.1.0

genderize v0.1.0 Genderize View Source

Link to this section Summary

Types

gender()
probability()

Functions

find(name)

Gets the gender and probability for a name

start_link()

Starts the Genderize process

Link to this section Types

Link to this type gender() View Source 
gender() :: :male | :female | :unknown
Link to this type probability() View Source 
probability() :: float()

Link to this section Functions

Link to this function find(name) View Source 
find(name :: binary()) :: {gender(), probability()}

Gets the gender and probability for a name.

Example 

Genderize.find("mary")
# => {:female, 1.0}
Genderize.find("john")
# => {:male, 1.0}
Genderize.find("asdf")
# => {:unknown, nil}
Link to this function start_link() View Source 
start_link() :: {:ok, pid()}

Starts the Genderize process.