I manage rows of parameter combinations, keyed by SSE and added in the order they appeared in an ade log file.

Construct an instance of me with a list of the parameter names you're interested in.

I can iterate over the parameter names, in order.

Method __init__ Undocumented
Method addRange Undocumented
Method setupNames Undocumented
Method __iter__ Undocumented
Method __len__ Undocumented
Method add Adds a new SSE entry, returning values and stars lists with placeholder None items for each parameter.
Method arrays Generates a 1-D Numpy array SSE with SSEs, and 2-D arrays of values and stars with one row per SSE and one column per parameter.
Method addMatches Adds items for all parameters found in the supplied line to the appropriate places in the supplied values and stars lists.
Method trim Trims my arrays to only include the entry with the best (latest) SSE and worse (earlier) entries representing a significant step in evolution toward the best SSE.
def __init__(self, names):
Undocumented
def addRange(self, reObj, name, ranger):
Undocumented
def setupNames(self, names):
Undocumented
def __iter__(self):
Undocumented
def __len__(self):
Undocumented
def add(self, SSE):

Adds a new SSE entry, returning values and stars lists with placeholder None items for each parameter.

You'll need to set each of those items to something else.

def arrays(self):

Generates a 1-D Numpy array SSE with SSEs, and 2-D arrays of values and stars with one row per SSE and one column per parameter.

def addMatches(self, line, values, stars):

Adds items for all parameters found in the supplied line to the appropriate places in the supplied values and stars lists.

Returns True if there are no items left to add.

def trim(self, maxRatio=2.0, maxDiff=0.01, maxRows=40):

Trims my arrays to only include the entry with the best (latest) SSE and worse (earlier) entries representing a significant step in evolution toward the best SSE.

The following criteria are applied to decide whether entries remain:

  1. SSE less than maxRatio (default 2.0) times the best SSE.
  2. SSE or at least one parameter as a relative difference of more than maxDiff (default 0.01, i.e., +/-1%) from the SSE or parameter of a better entry that is closest in SSE.
  3. No more than maxRows displayed (default 40).

Modifies the arrays, so calling this repeatedly will trim them some more.

API Documentation for ade, generated by pydoctor at 2022-11-17 13:13:22.