attr_praxis · fit_praxis · pval_praxis · stop_praxis

Optimization

fit_praxis()

Syntax:

min = h.fit_praxis(n, "funname", x._ref_x[0])

min = h.fit_praxis(n, "funname", Vector)

min = h.fit_praxis(..., ..., ..., "after quad statement")

min = h.fit_praxis(efun_as_python_callable, neuron_vector)

Description:

This is the principal axis method for minimizing a function. See praxis.c in the scopmath library.

1 <= n < 20

is the number of parameters to vary (number of arguments to funname).

funname

the name of the function to minimize, eg. least square difference between model and data. The funname must take two arguments, the first arg is the number of elements in second arg vector..

x

is a double Vector of at least length n. Prior to the call set it to a guess of the parameter values. On return it contains the values of the args that minimize funname().

funname may be either an interpreted HOC function or a compiled NMODL function. This form of calling cannot optimize Python functions directly.

If the variable stoprun is set to 1 during a call to fit_praxis, it will return immediately (when the current call to funname returns) with a return value and varx values set to the best minimum found so far. Use stop_praxis() to stop after finishing the current principal axis calculation.

The fourth argument, if present, specifies a statement to be executed at the end of each principal axis evaluation.

If the third argument is a Vector, then that style is used to specify the initial starting point and return the final value. However the function is still called with second arg as a pointer into a double array.

The Python callable form uses a Python Callable as the function to minimize and it must take a single NEURON Vector argument specifying the values of the parameters for use in evaluation the function. On entry to fit_praxis the Vector specifies the number of parameters and the parameter starting values. On return the vector contains the values of parameters which generated the least minimum found so far.

Example: minimize \((x+y - 5)^2 + 5*((x-y) - 15)^2\)

from neuron import h
v = h.Vector([0, 0])
def efun(v):
  return (v[0] + v[1] - 5) ** 2 + 5 * (v[0] -v[1] - 15) ** 2
h.attr_praxis(1e-5, 0.5, 0)
e = h.fit_praxis(efun, v)
print("e=%g x=%g y=%g\n"%(e, v[0], v[1]))

Warning

Up to version 4.0.1, the arguments to funname were an explicit list of n arguments. ie numarg()==n.

See also

attr_praxis(), stop_praxis(), pval_praxis()

---

attr_praxis()

Syntax:

h.attr_praxis(tolerance, maxstepsize, printmode)

previous_index = h.attr_praxis(mcell_ran4_index)

Description:

Set the attributes of the praxis method. This must be called before the first call to fit_praxis().

tolerance

praxis attempt to return f(x) such that if x0 is the true local minimum then norm(x-x0) < tolerance

maxstepsize

should be set to about the maximum distance from initial guess to the minimum.

printmode=0

no printing

printmode=1,2,3

more and more verbose

The single argument form causes praxis to pick its random numbers from the the mcellran4 generator beginning at the specified index. This allows reproducible fitting. The return value is the previously picked index. (see mcell_ran4())

---

pval_praxis()

Syntax:

pval = h.pval_praxis(i)

pval = h.pval_praxis(i, paxis._ref_x[0])

pval = h.pval_praxis(i, Vector)

Description:

Return the ith principal value. If the second argument is present, pval_praxis also fills the Vector with the ith principal axis.

---

stop_praxis()

Syntax:

h.stop_praxis()

h.stop_praxis(i)

Description:

Set a flag in the praxis function that will cause it to stop after it finishes the current (or ith subsequent) principal axis calculation. If this function is called before fit_praxis(), then praxis will do a single (or i) principal axis calculation and then exit.