From 5ce47a057e903048ea18fbe2028ae3ae77bf4ed5 Mon Sep 17 00:00:00 2001 From: David Keeney Date: Sat, 3 Jun 2023 17:25:41 -0700 Subject: [PATCH] Fix the set_parameter() description --- docs/NetworkAPI_Engine.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/NetworkAPI_Engine.md b/docs/NetworkAPI_Engine.md index 38b178a352..1437a345e8 100644 --- a/docs/NetworkAPI_Engine.md +++ b/docs/NetworkAPI_Engine.md @@ -53,7 +53,7 @@ In our app we first allocate a Network object and configure it with the topology {addLink: {src: "encoder.encoded", dest: "sp.bottomUpIn"}}, {addLink: {src: "sp.bottomUpOut", dest: "tm.bottomUpIn"}} ]}""" - net.configure(config); + net.configure(config) # iterate EPOCHS times x = 0.00 @@ -322,7 +322,7 @@ Member functions used by an app: getSpec( ) | returns the raw Spec object for this implementation. isParameter(name) | returns True if parameter exists. ***Getters***:
getParameterBool(name)
getParameterByte(name)
getParameterInt32(name)
getParameterUInt32(name)
getParameterInt64(name)
getParameterUInt64(name)
getParameterReal32(name)
getParameterReal64(name)
getParameterString(name) for C++

getParameter(name) for Python

getParameters()
getParameterJSON(name) for both C++ and Python.

getParameterArray(name, array)
getParameterArrayCount(name) for Arrays. | returns the value of the specified parameter from this region. - ***Setters***:
setParameterBool(name, value)
setParameterByte(name, value)
setParameterInt32(name, value)
setParameterUInt32(name, value)
setParameterInt64(name, value)
setParameterUInt64(name, value)
setParameterReal32(name, value)
setParameterReal64(name, value)
setParameterString(name, value) for C++

setParameter(name, value) for Python

setParameterJSON(name, value) for both C++ & Python

setParameterArray(name, array) | Sets the value on the specified parameter. The parameter must be declared with ReadWrite access mode in the Spec and the type of the parameter must match the type on the function name. setParameterJSON(name, value) can come from any type. + ***Setters***:
setParameterBool(name, value)
setParameterByte(name, value)
setParameterInt32(name, value)
setParameterUInt32(name, value)
setParameterInt64(name, value)
setParameterUInt64(name, value)
setParameterReal32(name, value)
setParameterReal64(name, value)
setParameterString(name, value)
setParameterJSON(name, value)
setParameterArray(name, array) | Sets the value on the specified parameter. The parameter must be declared with ReadWrite access mode in the Spec and the type of the parameter must match the type on the function name. setParameterJSON(name, value) can come from any type. getInputData(input_name) | Returns an input buffer as an Array object getOutputData(output_name) | Returns an output buffer as an Array object executeCommand(args) | Executes a command on the region. @@ -360,7 +360,7 @@ Gets the Spec object for a region's implementation. This is a static structure c ### Region\::getParameterArrayCount(name) -### Region\::setParameterXXX(name, value) C++
Region\::setParameter(name, value) Python +### Region\::setParameterXXX(name, value) where XXX is the type ### Region\::setParameterJSON(name, value)