Bad documentation help function

2 views (last 30 days)
francisco caldeira
francisco caldeira on 3 May 2020
Commented: Tommy on 4 May 2020
help(net.divideFcn)
This is incorret!
What help function do I use to check the property of an train the Network??
I tried this but don't work
help net.divideFcn

Answers (1)

Steven Lord
Steven Lord on 4 May 2020
help net.divideFcn
attempts to get help for the function whose name is divideFcn in the package folder named net.
help(net.divideFcn)
attempts to get help for the function whose name is returned by the function divideFcn in the package folder named net, whose name is stored in the divideFcn property of the object stored in the variable net, or whose name is stored in the divideFcn field of the struct array stored in the variable net.
These are two very different things.
  2 Comments
francisco caldeira
francisco caldeira on 4 May 2020
Read twice and don't understand your complicate language term.. you say one is a funcion other is help function??
I want to learn what means 'goal' in like 'net.trainParam.goal' , so I can't do like
help net.trainParam.goal
What I do??? Simple and clear I think.
Tommy
Tommy on 4 May 2020
The difference is similar to the difference between
>> help sum
sum Sum of elements.
S = sum(X) is the sum of the elements of the vector X. If X is a matrix,
...
which displays help for the function sum(), and
>> help(sum)
Error using sum
Not enough input arguments.
which first evaluates sum and then displays help for whatever the output was.
help(net.divideFcn)
This line is intended to be run when you have a neural network object called net. Neural network objects have a property named divideFcn which "defines the data division function to be used when the network is trained using a supervised algorithm" (from here). So the above line first evaluates net.divideFcn to obtain the data division function, and it then displays help for whatever that data division function is.

Sign in to comment.

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!