-
Notifications
You must be signed in to change notification settings - Fork 42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixed a bug when restoring master cuts in strong branching #444
Conversation
…eral debugging tools used to find the bug
Codecov Report
@@ Coverage Diff @@
## master #444 +/- ##
==========================================
+ Coverage 80.14% 80.55% +0.41%
==========================================
Files 50 50
Lines 4301 4305 +4
==========================================
+ Hits 3447 3468 +21
+ Misses 854 837 -17
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Artur, can you explain how your debugging tools work?
@@ -178,10 +178,6 @@ function perform_strong_branching_with_phases!( | |||
|
|||
sort!(groups, rev = true, by = x -> (x.isconquered, x.score)) | |||
|
|||
if groups[1].isconquered | |||
nb_candidates_for_next_phase == 1 | |||
end |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Artur, why did you remove this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi Ruslan. I think it had no effect. Did you intend to use = instead of == ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Anyway, we decided to let the nodes survive a little bit more before being deleted to let them appear in the branch tree file. We don't think there will be a significant impact in the performance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it should be =. This is needed to avoid unnecessary evaluation of branching candidates, when one of candidates is already conquered.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest marking it as conquered and testing it in the beginning of the evaluation to avoid evaluating it again but letting it persist until being written to the branch tree file (equivalent to BaPTree.dot). Otherwise some nodes will appear with only one child.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did not completely get your point. Branching candidate (group) here is not a child node, but a complete set of child nodes (left branch and right branch). The group is already marked as conquered and will not be evaluated again. This is to avoid passing other candidates (or groups) to the next strong branching phase. Thus we avoid evaluating them. This evaluation is not needed as there exists a conquered branching candidate, i.e. all children nodes are conquered. We pass only this branching candidate, and all child nodes of this candidate will appear in the branch tree file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah! ok. Got it. So, we should put the code back with = replacing ==.
@@ -27,7 +27,8 @@ end | |||
|
|||
# CutCallbacks does not have child algorithms, therefore get_child_algorithms() is not defined | |||
|
|||
function get_storages_usage(algo::CutCallbacks, form::Formulation{MathProg.AbstractMasterDuty}) | |||
function get_storages_usage(algo::CutCallbacks, form::Formulation{Duty} | |||
) where {Duty<:MathProg.AbstractFormDuty} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Sorry for this bug.
src/Coluna.jl
Outdated
println(l) | ||
end | ||
end | ||
macro debug() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it possible to add a debug parameter and a test to cover these debug functions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The debug tool should not stay in the code. Can we move it to the documentation ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem. I just did not want to loose it.
src/Algorithm/basic/solvelpform.jl
Outdated
@@ -47,7 +47,12 @@ function optimize_lp_form!( | |||
algo::SolveLpForm, optimizer::MoiOptimizer, form::Formulation, result::OptimizationState | |||
) | |||
MOI.set(form.optimizer.inner, MOI.Silent(), algo.silent) | |||
# MOI.set(form.optimizer.inner, MOI.RawParameter("Method"), 2) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we remove these comments ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem.
src/MOIcallbacks.jl
Outdated
@@ -100,7 +100,7 @@ function MOI.submit( | |||
end | |||
|
|||
constr = setconstr!( | |||
form, "", MasterMixedConstr; | |||
form, "", MasterBendCutConstr; #TODO: Create a specific type for user cuts |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why did you change the duty ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is important. I had to fix two things to make it work. This is one of them. The user cuts were not being recognized by the constructor of MasterCutsState because of the condition "getduty(id) <= AbstractMasterCutConstr" and I did not want to change the complex hierarchy defined in "duties.jl". So defining it as a MasterBendCutConstr was a solution with minimum changes to avoid generating new bugs.
I think it is worth letting a general comment about the code structure here. I think it would help a lot for people that starts looking at the code if there was a more clearly marked standard structure for the storages that were followed by all algorithms. Perhaps we could put each algorithm and each storage type in a separate file and force all storage functions to be redefined (like get_storages_usage and get_child_algorithms) even if they do nothing (by generating an error message in the function that receives the abstract type). Calls to restore_states!, store_states! and remove_states! could perhaps be more emphasised and/or we could try to keep them in the first call level (function run!) of their algorithms. |
I agree that we need a document describing the architecture of Coluna (environment, models, formulations, algorithms, storages, and other concepts we use). Guillaume should have started such a document. I will review and complete it when Guillaume is done with his part. A link to this document should be in the README.md file. |
…nches, and creating a new duty for master cuts
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One style issue to address and then the PR is ready to be merged.
src/Algorithm/storage.jl
Outdated
@@ -90,6 +90,13 @@ const StorageTypePair = Pair{DataType, DataType} | |||
# be restored for writing (all other storages are restored anyway but just for reading) | |||
const StoragesUsageDict = Dict{Tuple{AbstractModel, StorageTypePair}, StorageAccessMode} | |||
|
|||
function Base.show(io::IO, stoUsaDict::StoragesUsageDict) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Variable name must be lower case.
Note: I have added several (disabled) debugging tools used to find the bug.