Trees       Indices       Help   
The Jazz Parser (r2525)
nltk :: probability :: DictionaryProbDist :: Class DictionaryProbDist
[hide private]
[frames] | no frames]

Class DictionaryProbDist

object --+    
         |    
 ProbDistI --+
             |
            DictionaryProbDist

A probability distribution whose probabilities are directly specified by a given dictionary. The given dictionary maps samples to probabilities.

Instance Methods [hide private]
 
__init__(self, prob_dict=None, log=False, normalize=False)
Construct a new probability distribution from the given dictionary, which maps values to probabilities (or to log probabilities, if log is true).
 
__repr__(self)
repr(x)
float
logprob(self, sample)
Returns: the base 2 logarithm of the probability for a given sample.
any
max(self)
Returns: the sample with the greatest probability.
float
prob(self, sample)
Returns: the probability for a given sample.
list
samples(self)
Returns: A list of all samples that have nonzero probabilities.

Inherited from ProbDistI: discount, generate

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from ProbDistI: SUM_TO_ONE

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, prob_dict=None, log=False, normalize=False)
(Constructor)

 

Construct a new probability distribution from the given dictionary, which maps values to probabilities (or to log probabilities, if log is true). If normalize is true, then the probability values are scaled by a constant factor such that they sum to 1.

Overrides: object.__init__

__repr__(self)
(Representation operator)

 

repr(x)

Overrides: object.__repr__
(inherited documentation)

logprob(self, sample)

 
Parameters:
  • sample - The sample whose probability should be returned.
Returns: float
the base 2 logarithm of the probability for a given sample. Log probabilities range from negitive infinity to zero.
Overrides: ProbDistI.logprob
(inherited documentation)

max(self)

 
Returns: any
the sample with the greatest probability. If two or more samples have the same probability, return one of them; which sample is returned is undefined.
Overrides: ProbDistI.max
(inherited documentation)

prob(self, sample)

 
Parameters:
  • sample - The sample whose probability should be returned.
Returns: float
the probability for a given sample. Probabilities are always real numbers in the range [0, 1].
Overrides: ProbDistI.prob
(inherited documentation)

samples(self)

 
Returns: list
A list of all samples that have nonzero probabilities. Use prob to find the probability of each sample.
Overrides: ProbDistI.samples
(inherited documentation)

   Trees       Indices       Help   
The Jazz Parser (r2525)
Generated by Epydoc 3.0.1 on Mon Nov 26 16:04:58 2012 http://epydoc.sourceforge.net