NuPIC  0.2.7.dev0
Numenta Platform for Intelligent Computing
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
LogEncoder Class Reference

This class wraps the ScalarEncoder class. More...

Inheritance diagram for LogEncoder:

Public Member Functions

def getDecoderOutputFieldTypes
 Encoder class virtual method override.
def getBucketIndices
 See the function description in
def encodeIntoArray
 See the function description in
def decode
 See the function description in
def getBucketValues
 See the function description in
def getBucketInfo
 See the function description in
def topDownCompute
 See the function description in
def closenessScores
 See the function description in
- Public Member Functions inherited from Encoder
def getWidth
 Should return the output width, in bits. More...
def encodeIntoArray
 Encodes inputData and puts the encoded value into the numpy output array, which is a 1-D array of length returned by getWidth(). More...
def setLearning
 Set whether learning is enabled. More...
def setFieldStats
 This method is called by the model to set the statistics like min and max for the underlying encoders if this information is available. More...
def encode
 Convenience wrapper for encodeIntoArray. More...
def getScalarNames
 Return the field names for each of the scalar values returned by getScalars. More...
def getDecoderOutputFieldTypes
 Returns a sequence of field types corresponding to the elements in the decoded output field array. More...
def setStateLock
 Setting this to true freezes the state of the encoder This is separate from the learning state which affects changing parameters. More...
def getEncoderList
def getScalars
 Returns a numpy array containing the sub-field scalar value(s) for each sub-field of the inputData. More...
def getEncodedValues
 Returns the input in the same format as is returned by topDownCompute(). More...
def getBucketIndices
 Returns an array containing the sub-field bucket indices for each sub-field of the inputData. More...
def scalarsToStr
 Return a pretty print string representing the return values from getScalars and getScalarNames(). More...
def getDescription
 This returns a list of tuples, each containing (name, offset). More...
def getFieldDescription
 Return the offset and length of a given field within the encoded output. More...
def encodedBitDescription
 Return a description of the given bit in the encoded output. More...
def pprintHeader
 Pretty-print a header that labels the sub-fields of the encoded output. More...
def pprint
 Pretty-print the encoded output using ascii art. More...
def decode
 Takes an encoded output and does its best to work backwards and generate the input that would have generated it. More...
def decodedToStr
 Return a pretty print string representing the return value from decode().
def getBucketValues
 Returns a list of items, one for each bucket defined by this encoder. More...
def getBucketInfo
 Returns a list of EncoderResult namedtuples describing the inputs for each sub-field that correspond to the bucket indices passed in 'buckets'. More...
def topDownCompute
 Returns a list of EncoderResult namedtuples describing the top-down best guess inputs for each sub-field given the encoded output. More...
def closenessScores
 Compute closeness scores between the expected scalar value(s) and actual scalar value(s). More...
def getDisplayWidth
 Calculate width of display for bits plus blanks between fields. More...
def formatBits
 Copy one array to another, inserting blanks between fields (for display) If leftpad is one, then there is a dummy value at element 0 of the arrays, and we should start our counting from 1 rather than 0. More...

Detailed Description

This class wraps the ScalarEncoder class.

A Log encoder represents a floating point value on a logarithmic scale.

valueToEncode = log10(input)

w – number of bits to set in output minval – minimum input value. must be greater than 0. Lower values are reset to this value maxval – maximum input value (input is strictly less if periodic == True) periodic – If true, then the input value "wraps around" such that minval = maxval For a periodic value, the input must be strictly less than maxval, otherwise maxval is a true upper bound.

Exactly one of n, radius, resolution must be set. "0" is a special value that means "not set".

n – number of bits in the representation (must be > w) radius – inputs separated by more than this distance in log space will have non-overlapping representations resolution – The minimum change in scaled value needed to produce a change in encoding. This should be specified in log space. For example, the scaled values 10 and 11 will be distinguishable in the output. In terms of the original input values, this means 10^1 (1) and 10^1.1 (1.25) will be distinguishable. name – an optional string which will become part of the description verbosity – level of debugging output you want the encoder to provide. clipInput – if true, non-periodic inputs smaller than minval or greater than maxval will be clipped to minval/maxval forced – (default False), if True, skip some safety checks

The documentation for this class was generated from the following file: