You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
The variables that are optimized (controls in Everest nomenclature) are specified in a nested fashion: We have controls, which defines groups of variables, which in turn can have multiple components labeled with an integer index. For example (from config_advanced.yml):
This defines three controls, with the following control, variable, and index fields:
point, x, 0
point, x, 1
point, x, 2
When reporting results, control names are constructed from the three fields as follows control_variable-index, so we get:
point_x-0
point_x-1
point_x-2
When specifying input constraints, weights need to be set for a sub-set of controls, so controls are needed, but in this case they follow the form control.variable-index. For instance (from config_advanced.yml):
This is inconsistent and potentially confusing for the user.
Describe the solution you'd like
When a string representation of controls is shown, or required as an input, it should always have the same form. There should be a singe function/method responsible for formatting the string from control, variable, index fields. Preferably this transformation should be invertible, although we should not rely on that in code. If possible, the delimiters used should not be allowed in control and variable names. We should discuss the delimiters to use, but using . and - would be backwards compatible for specifying input constraints and it would leave the underscore available for control and variable naming.
The text was updated successfully, but these errors were encountered:
Is your feature request related to a problem? Please describe.
The variables that are optimized (controls in Everest nomenclature) are specified in a nested fashion: We have controls, which defines groups of variables, which in turn can have multiple components labeled with an integer index. For example (from
config_advanced.yml
):This defines three controls, with the following
control
,variable
, andindex
fields:point
,x
,0
point
,x
,1
point
,x
,2
When reporting results, control names are constructed from the three fields as follows
control_variable-index
, so we get:point_x-0
point_x-1
point_x-2
When specifying input constraints, weights need to be set for a sub-set of controls, so controls are needed, but in this case they follow the form
control.variable-index
. For instance (fromconfig_advanced.yml
):This is inconsistent and potentially confusing for the user.
Describe the solution you'd like
When a string representation of controls is shown, or required as an input, it should always have the same form. There should be a singe function/method responsible for formatting the string from
control
,variable
,index
fields. Preferably this transformation should be invertible, although we should not rely on that in code. If possible, the delimiters used should not be allowed in control and variable names. We should discuss the delimiters to use, but using.
and-
would be backwards compatible for specifying input constraints and it would leave the underscore available for control and variable naming.The text was updated successfully, but these errors were encountered: