Skip to content

Commit 5ce47a0

Browse files
committed
Fix the set_parameter() description
1 parent f3d2905 commit 5ce47a0

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/NetworkAPI_Engine.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ In our app we first allocate a Network object and configure it with the topology
5353
{addLink: {src: "encoder.encoded", dest: "sp.bottomUpIn"}},
5454
{addLink: {src: "sp.bottomUpOut", dest: "tm.bottomUpIn"}}
5555
]}"""
56-
net.configure(config);
56+
net.configure(config)
5757
5858
# iterate EPOCHS times
5959
x = 0.00
@@ -322,7 +322,7 @@ Member functions used by an app:
322322
getSpec( ) | returns the raw Spec object for this implementation.
323323
isParameter(name) | returns True if parameter exists.
324324
***Getters***: <br/> getParameterBool(name)<br/> getParameterByte(name)<br/> getParameterInt32(name)<br/> getParameterUInt32(name)<br/> getParameterInt64(name)<br/> getParameterUInt64(name)<br/> getParameterReal32(name)<br/> getParameterReal64(name)<br/> getParameterString(name) for C++<br/><br/> getParameter(name) for Python <br/><br/> getParameters() <br/> getParameterJSON(name) for both C++ and Python.<br/><br/> getParameterArray(name, array)<br/> getParameterArrayCount(name) for Arrays. | returns the value of the specified parameter from this region.
325-
***Setters***:<br/> setParameterBool(name, value)<br/> setParameterByte(name, value)<br/> setParameterInt32(name, value)<br/> setParameterUInt32(name, value)<br/> setParameterInt64(name, value)<br/> setParameterUInt64(name, value)<br/> setParameterReal32(name, value)<br/> setParameterReal64(name, value)<br/> setParameterString(name, value) for C++ <br/><br/> setParameter(name, value) for Python<br/><br/> setParameterJSON(name, value) for both C++ & Python<br/><br/> 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.
325+
***Setters***:<br/> setParameterBool(name, value)<br/> setParameterByte(name, value)<br/> setParameterInt32(name, value)<br/> setParameterUInt32(name, value)<br/> setParameterInt64(name, value)<br/> setParameterUInt64(name, value)<br/> setParameterReal32(name, value)<br/> setParameterReal64(name, value)<br/> setParameterString(name, value)<br/> setParameterJSON(name, value)<br/> 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.
326326
getInputData(input_name) | Returns an input buffer as an Array object
327327
getOutputData(output_name) | Returns an output buffer as an Array object
328328
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
360360

361361
### Region\::getParameterArrayCount(name)
362362

363-
### Region\::setParameterXXX(name, value) C++ <br/> Region\::setParameter(name, value) Python
363+
### Region\::setParameterXXX(name, value) where XXX is the type
364364

365365
### Region\::setParameterJSON(name, value)
366366

0 commit comments

Comments
 (0)