Provision to enforce types in parameters, variables and structural_parameters in @mtkmodel
#2500
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ral_parameters in `@mtkmodel` Check that specified default is of specified type. Add types to corresponding keyword arg.
ven-k
commented
Feb 27, 2024
| :components => [[:model_a, :ModelA]] | ||
| :variables => Dict{Symbol, Dict{Symbol, Any}}(:v=>Dict(:default=>:v_var), :v_array=>Dict(:size=>(2, 3))) | ||
| :icon => URI("https://github.com/SciML/SciMLDocs/blob/main/docs/src/assets/logo.png") | ||
| :kwargs => Dict{Symbol, Dict}(:f=>Dict(:value=>:sin), :v=>Dict{Symbol, Union{Nothing, Symbol}}(:value=>:v_var, :type=>nothing), :v_array=>Dict(:value=>nothing, :type=>nothing), :p1=>Dict(:value=>nothing)) |
There was a problem hiding this comment.
Notice that, in structure dictionary,
:kwargs => Dict{Symbol, Any}(:f=>:sin, :v=>:v_var, :v_array=>nothing, :model_a__k_array=>nothing, :p1=>nothing)is now modified to:
:kwargs => Dict{Symbol, Dict}(:f=>Dict(:value=>:sin), :v=>Dict{Symbol, Union{Nothing, Symbol}}(:value=>:v_var, :type=>nothing), :v_array=>Dict(:value=>nothing, :type=>nothing), :p1=>Dict(:value=>nothing))i.e kwargs dictionary has a sub-dictionary with :value and :type, to store the latter metadata.
As it was Any before, one could argue this is still not a breaking change.
However, note that the required changes can live without this, albeit with incomplete info.
@ChrisRackauckas should I drop this change or can this be added.
|
I've verified that model_parsing.jl tests pass locally. CI fails before that in an unrelated test (Optimization test) to this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2491
Check that specified default for a variable is of specified type.
Add types to corresponding keyword arg.
While here, fix the missing metadata of structural_parameters in model-structure.
Checklist
contributor guidelines, in particular the SciML Style Guide and
COLPRAC.
Additional context
Note that
@variables t k(t)::Int = 1.5works just fine. So here,@mtkmodelenforces its own checks for defaults and restricts users providing incorrect input by adding types to the keyword argument.