For functions on the component level, use the same syntax but add the component level, such as model.component(<ctag>).func().create(<tag>,<type>)
|
When using a local table the interpolation function uses the funcname property to set the function name. When the data comes from a file or a result table, the name is specified in the funcs string matrix property. This is necessary because there can be more than one function.
|
automatic | manual
|
|||
Contains one value for each function argument. A false value means that the corresponding function argument will be constant when plotting. The constant value is taken from the lower limit value in the plotargs property. Constant arguments do no use an axis in the plot. Up to 3 axes are supported when plotting. Specify using setIndex("plotaxis", false, 2), for example.
|
|||
on | off
|
|||
on | off
|
|||
If source is file and defvars is set to true, the spatial coordinate variables are used as default arguments to the function if no arguments are supplied in a call to it.
|
|||
point | comma
|
|||
If source is table and defineinv is on: The name of the inverse function.
|
|||
Used source is file; the first column contains function names and the second column contains the positions in the file where the corresponding function is defined.
|
|||
Define a primitive function with the name give as primfunname.
|
|||
Define a primitive function with the name give as primfunname.
|
|||
If true, reinterpolate interpolation data on computational mesh. Available if defvars is true and frame is set to mesh.
|
|||
The tag of the result table to use (tbl1, for example).
|
|||
automatic | uniform
|
|||
Apply scaling of data if the bounding box of the interpolation points has a bad aspect ratio (auto), always apply the scaling (on), or turn off scaling altogether (off).
|
|||
model | user
|
|||
none | logarithmic
|
|||
none | logarithmic
|
integral | peak
|
The tag name + _cum
|
|||
The tag name + _cum_inv
|
|||
rn_ + the tag name
|
|||
If true, the random seed will be used.
|
|||
manual | currenttime
|
|||
uniform | normal
|
|||
See https://www.comsol.com/system-requirements for information about supported compiler versions.
|
neighbor | linear
|
none | manual
|
|||
neighbor | linear
|
|||
automatic | manual
|
|||
The argument names for the defined function(s), as an array of alternating column names from the input data and argument names. Using the setEntry, getEntryKeys, getEntryKeyIndex methods makes it easier to work with this array.
|
|||
Defines the types of columns in the input data, as an array of alternative column names and column types. Valid column types are none, arg, and value. See also the description of the args property.
|
|||
Type of covariance function to use in the Gaussian process regression. Use se for Squared exponential, matern32 for Matérn 3/2, matern52 for Matérn 5/2 and nn for Single-layer neural network.
|
|||
If true, the related error estimation function(s) are made available.
|
|||
The description for each function argument and function value, as an array of alternating function arguments or values and their descriptions. Using the setEntry, getEntryKeys, getEntryKeyIndex methods makes it easier to work with this array.
|
|||
point | comma
|
|||
Custom column names to be displayed in the column settings table. This property is updated automatically when file input data properties are changed. Column header names are taken from the last line in the file that starts with a '%' character. The line is split on " " (double space), tab character, and comma character, and each part is used as one custom column name.
|
|||
The fraction of input data to set aside for validation of the trained function(s). Used when validation is one of random, fraction, last.
|
|||
If true, causes lines in the training data that contain any NaN or Inf values to be ignored. If false, NaN and Inf values are treated as an error.
|
|||
Random number seed used for validation of the trained function(s). Used when validation is random and useseedtest is manual.
|
|||
Contains one value for each function argument. A false value means that the corresponding function argument will be constant when plotting. The constant value is taken from the lower limit value in the plotargs property. Constant arguments do no use an axis in the plot. Up to 3 axes are supported when plotting. Specify using setIndex("plotaxis", false, 2), for example.
|
|||
Contains one value for each function argument. For arguments that do not have an axis in the plot (see plotaxis), this property specifies the fixed value to use in the plot.
|
|||
automatic | manual
|
Controls how the number of restart points during training is determined. If automatic, the number is calculated from the number of function arguments. If manual, the number is given by the manualrestarthypergpnumber property.
|
||
file | resultTable
|
|||
If validation is not none, specifies the table where verification error summary is stored. Use none to not generate the table data. Use new to create a new table for the data. Use a results table tag to store the data in an existing table.
|
|||
If validation is not none, specifies the table where detailed verification error information is stored. Use none to not generate the table data. Use new to create a new table for the data. Use a results table tag to store the data in an existing table.
|
|||
manual | currenttime
|
Specifies how the random seed for training is determined. If manual, the seed is given by the lastinternalseed property. If currenttime, the seed is computed from the current time when training is started.
|
||
manual | currenttime
|
Specifies how the random seed for validation is determined. If manual, the seed is given by the lastinternalseedtest property. If currenttime, the seed is computed from the current time when training is started.
|
||
none: No validation is performed.
random: Use a random sample of the input data and exclude the corresponding values from the training data. The size of the sample is fraction times the number of input data points.
fraction: Use every 1/fraction values from the input data and exclude the corresponding values from the training data.
last: Use the last part of the input data and exclude the corresponding values from the training data. The size of the last part is fraction times the number of input data points.
table: Use a results table as validation data.
|
|||
The argument names for the defined function(s), as an array of alternating column names from the input data and argument names. Using the setEntry, getEntryKeys, getEntryKeyIndex methods makes it easier to work with this array.
|
|||
Defines the types of columns in the input data, as an array of alternative column names and column types. Valid column types are none, arg, and value. See also the description of the args property.
|
|||
The description for each function argument and function value, as an array of alternating function arguments or values and their descriptions. Using the setEntry, getEntryKeys, getEntryKeyIndex methods makes it easier to work with this array.
|
|||
Defines the probability distributions for the function arguments, as an array of alternative column names and distribution types. Valid distribution types are uniform, normal, lognormal, gamma, beta, weibull, and gumbel. See also the description of the args property.
|
|||
point | comma
|
|||
Custom column names to be displayed in the column settings table. This property is updated automatically when file input data properties are changed. Column header names are taken from the last line in the file that starts with a '%' character. The line is split on " " (double space), tab character and comma character and each part is used as one custom column name.
|
|||
The fraction of input data to set aside for validation of the trained function(s). Used when validation is one of random, fraction, last.
|
|||
If true, causes lines in the training data that contain any NaN or Inf values to be ignored. If false, NaN and Inf values are treated as an error.
|
|||
Random number seed used for validation of the trained function(s). Used when validation is random and useseedtest is manual.
|
|||
Defines how the lower bounds of the valid range for the function arguments are determined, as an array of alternative column names and CDF (cumulative distribution function) values. Valid CDF values are 0.3, 0.1, 0.01, 0.001, 1e-4, 1e-5, 1e-6, 1e-7, and manual. Not used if distributionselection is uniform or beta. See also the description of the args property.
|
|||
warning | cancel
|
Decides how to handle out-of-range and extrapolated training data. If outofrange is cancel, the training is canceled. If outofrange is warning, the training continues, but a warning is added under the function feature. In either case, details about the problematic training data points are logged in the log window.
|
||
auto | manual
|
If pcesettings is set to auto, the training will automatically determine the required polynomial degree needed to obtain suitable accuracy. If pcesettings is set to manual, the maximum polynomial degree is determined by the polydegreespce and qnorm settings.
|
||
Contains one value for each function argument. A false value means that the corresponding function argument will be constant when plotting. The constant value is taken from the lower limit value in the plotargs property. Constant arguments do no use an axis in the plot. Up to 3 axes are supported when plotting. Specify using setIndex("plotaxis", false, 2), for example.
|
|||
Contains one value for each function argument. For arguments that do not have an axis in the plot (see plotaxis), this property specifies the fixed value to use in the plot.
|
|||
The maximum polynomial degree to use when pcesettings is set to manual. See also the Uncertainty Quantification Module User’s Guide.
|
|||
Controls the hyperbolic truncation of polynomial terms used for functions having more than one argument. Only used when pcesettings is set to manual. See also the Uncertainty Quantification Module User’s Guide.
|
|||
Defines the first probability distribution parameter for the function arguments as an array of alternative column names and distribution parameters. Not used if distributionselection is set to uniform. See also the description of the args property.
|
|||
Defines the second probability distribution parameter for the function arguments as an array of alternative column names and distribution parameters. Not used if distributionselection is set to uniform. See also the description of the args property.
|
|||
file | resultTable
|
|||
The tolerance used when deciding the required polynomial degree of the trained function. See also the Uncertainty Quantification Module User’s Guide.
|
|||
If validation is not none, specifies the table where verification error summary is stored. Use none to not generate the table data. Use new to create a new table for the data. Use a results table tag to store the data in an existing table.
|
|||
If validation is not none, specifies the table where detailed verification error information is stored. Use none to not generate the table data. Use new to create a new table for the data. Use a results table tag to store the data in an existing table.
|
|||
Defines the upper bound of the valid input range for the function arguments as an array of alternative column names and upper bounds. Only relevant if distributionselection is set to uniform or beta, or if ucdfselection is set to manual. See also the description of the args property.
|
|||
Defines how the upper bounds of the valid range for the function arguments are determined as an array of alternative column names and CDF (cumulative distribution function) values. Valid CDF values are 0.7, 0.9, 0.99, 0.999, 1-1e-4, 1-1e-5, 1-1e-6, 1-1e-7, and manual. Not used if distributionselection is set to uniform or beta. See also the description of the args property.
|
|||
manual | currenttime
|
Specifies how the random seed for validation is determined. If manual, the seed is given by the lastinternalseedtest property. If currenttime, the seed is computed from the current time when training is started.
|
||
none: No validation is performed.
random: Use a random sample of the input data and exclude the corresponding values from the training data. The size of the sample is fraction times the number of input data points.
fraction: Use every 1/fraction values from the input data and exclude the corresponding values from the training data.
last: Use the last part of the input data and exclude the corresponding values from the training data. The size of the last part is fraction times the number of input data points.
table: Use a results table as validation data.
|
|||
The argument names for the defined function(s), as an array of alternating column names from the input data and argument names. Using the setEntry, getEntryKeys, getEntryKeyIndex methods makes it easier to work with this array.
|
|||
The description for each function argument and function value, as an array of alternating function arguments or values and their descriptions. Using the setEntry, getEntryKeys, getEntryKeyIndex methods makes it easier to work with this array.
|
|||
array of dense
|
|||
mse | mae
|
|||
adam | sgd
|
|||
Contains one value for each function argument. A false value means that the corresponding function argument will be constant when plotting. The constant value is taken from the lower limit value in the plotargs property. Constant arguments do no use an axis in the plot. Up to 3 axes are supported when plotting. Specify using setIndex("plotaxis", false, 2), for example.
|
|||
Contains one value for each function argument. For arguments that do not have an axis in the plot (see plotaxis), this property specifies the fixed value to use in the plot.
|
|||
file | resultTable
|
|||
manual | currenttime
|
Specifies how the random seed for training is determined. If manual, the seed is given by the rndseed property. If currenttime, the seed is computed from the current time when training is started.
|
||
manual | currenttime
|
Specifies how the random seed for validation is determined. If manual, the seed is given by the rndseed property. If currenttime, the seed is computed from the current time when training is started.
|
||
point | comma
|
|||
file | resultTable
|
|||