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

Class ConditionalProbDist

          object --+    
                   |    
ConditionalProbDistI --+
                       |
                      ConditionalProbDist

A conditional probability distribution modelling the experiments that were used to generate a conditional frequency distribution. A ConditoinalProbDist is constructed from a ConditionalFreqDist and a ProbDist factory:

The first argument to the ProbDist factory is the frequency distribution that it should model; and the remaining arguments are specified by the factory_args parameter to the ConditionalProbDist constructor. For example, the following code constructs a ConditionalProbDist, where the probability distribution for each condition is an ELEProbDist with 10 bins:

>>> cpdist = ConditionalProbDist(cfdist, ELEProbDist, 10)
>>> print cpdist['run'].max()
'NN'
>>> print cpdist['run'].prob('NN')
0.0813
Instance Methods [hide private]
 
__contains__(self, condition)
ProbDistI
__getitem__(self, condition)
Returns: The probability distribution for the experiment run under the given condition.
 
__init__(self, cfdist, probdist_factory, *factory_args, **factory_kw_args)
Construct a new conditional probability distribution, based on the given conditional frequency distribution and ProbDist factory.
int
__len__(self)
Returns: The number of conditions that are represented by this ConditionalProbDist.
list
conditions(self)
Returns: A list of the conditions that are represented by this ConditionalProbDist.

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__getitem__(self, condition)
(Indexing operator)

 
Parameters:
  • condition - The condition whose probability distribution should be returned.
Returns: ProbDistI
The probability distribution for the experiment run under the given condition.
Overrides: ConditionalProbDistI.__getitem__
(inherited documentation)

__init__(self, cfdist, probdist_factory, *factory_args, **factory_kw_args)
(Constructor)

 

Construct a new conditional probability distribution, based on the given conditional frequency distribution and ProbDist factory.

Parameters:
  • cfdist (ConditionalFreqDist) - The ConditionalFreqDist specifying the frequency distribution for each condition.
  • probdist_factory (class or function) - The function or class that maps a condition's frequency distribution to its probability distribution. The function is called with the frequency distribution as its first argument, factory_args as its remaining arguments, and factory_kw_args as keyword arguments.
  • factory_args ((any)) - Extra arguments for probdist_factory. These arguments are usually used to specify extra properties for the probability distributions of individual conditions, such as the number of bins they contain.
  • factory_kw_args ((any)) - Extra keyword arguments for probdist_factory.
Overrides: object.__init__

__len__(self)
(Length operator)

 
Returns: int
The number of conditions that are represented by this ConditionalProbDist.
Overrides: ConditionalProbDistI.__len__
(inherited documentation)

conditions(self)

 
Returns: list
A list of the conditions that are represented by this ConditionalProbDist. Use the indexing operator to access the probability distribution for a given condition.
Overrides: ConditionalProbDistI.conditions
(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