8.8 solver parameters [ANT-2280] #2466

payetvin · 2024-10-17T14:59:30Z

This pull request introduces several significant changes to the Antares project, focusing on adding support for solver-specific parameters and restructuring the optimization options. The key changes include the creation of a new optimization-options module, refactoring of existing code to use this module, and enhancements to error handling related to solver parameters.

New Module Addition:

Added a new optimization-options module to encapsulate all options related to optimization (src/libs/antares/optimization-options/*). [1] [2]

Code Refactoring:

Refactored StudyLoadOptions and Parameters classes to use the new OptimizationOptions structure for managing solver-related options (src/libs/antares/study/load-options.h, src/libs/antares/study/load-options.cpp, src/libs/antares/study/parameters.h, src/libs/antares/study/parameters.cpp). [1] [2] [3] [4]

Error Handling Enhancements:

Introduced a new InvalidSolverSpecificParameters exception to handle invalid solver-specific parameters (src/libs/antares/exception/LoadingError.hpp, src/libs/antares/exception/LoadingError.cpp). [1] [2]

Documentation Updates:

Updated the command line reference guide to include the new --solver-parameters option (docs/reference-guide/10-command_line.md).

Miscellaneous:

Moved the add_subdirectory(writer) command in CMakeLists.txt to ensure proper build order (src/libs/antares/CMakeLists.txt). [1] [2]

pet-mit · 2024-11-04T13:38:46Z

docs/reference-guide/10-command_line.md

maybe use the same exhaustive example to show both scip & xpress usages : Set solver-specific parameters, for instance --solver-parameters="THREADS 1 PRESOLVE 1" for XPRESS or --solver-parameters="parallel/maxnthreads 1, lp/presolving TRUE" for SCIP. Syntax is solver-dependent, and only supported for SCIP & XPRESS.

pet-mit · 2024-11-04T13:46:06Z

src/solver/application/application.cpp

@@ -11,7 +11,7 @@
 #include <antares/version.h>
 #include <antares/writer/writer_factory.h>

-#include "signal-handling/public.h"
+#include "../signal-handling/public.h"


Indeed, why do we have this new magic inclusion, though no change here seems to call for this inclusion ?

src/solver/misc/options.cpp

src/solver/utils/include/antares/solver/utils/named_problem.h

pet-mit · 2024-11-04T13:53:56Z

src/tests/src/solver/simulation/tests-ts-numbers.cpp

@@ -6,7 +6,7 @@
 #include <boost/test/unit_test.hpp>

 #include <timeseries-numbers.h>
-#include "ts-generator/generator.h"
+#include "../../../../solver/ts-generator/generator.h"


pet-mit

update antares batch launcher script

pet-mit

would like to have someone else's opinion on batchrun. rest is OK for me

guilpier-code · 2024-11-08T09:09:44Z

src/libs/antares/CMakeLists.txt

@@ -19,6 +18,9 @@ add_subdirectory(io)
 add_subdirectory(exception)

 add_subdirectory(sys)
+add_subdirectory(writer)
+
+add_subdirectory(optimization-options)


Why do we add a directory src/libs/antares/optimization-options ?
We could add a folder src/solver/optimization-options instead, it would seem more natural, wouldn't it ?

Parameters are related to study

guilpier-code · 2024-11-08T09:20:04Z

src/libs/antares/checks/antares/checks/checkLoadedInputData.h

@@ -24,12 +24,17 @@
 **
 ** SPDX-License-Identifier: licenceRef-GPL3_WITH_RTE-Exceptions
 */
+#include "antares/optimization-options/options.h"


Current header checkLoadedInputData.h doesn't seem to use types defined in antares/optimization-options/options.h.
The latter header should not be included here.

src/libs/antares/checks/antares/checks/checkLoadedInputData.h

src/libs/antares/optimization-options/include/antares/optimization-options/options.h

src/libs/antares/exception/LoadingError.cpp

src/solver/misc/options.cpp

guilpier-code · 2024-11-08T13:12:02Z

src/tools/batchrun/main.cpp

@@ -246,19 +127,13 @@ int main(int argc, char* argv[])
        if (not finder.list.empty())


About :

if (not finder.list.empty())

is useless : the loop over the found studies won't start if there are no study in the finder.

Yeah but there will be no clear error message without this condition

src/tools/batchrun/main.cpp

guilpier-code · 2024-11-08T13:19:53Z

src/tools/batchrun/main.cpp

+
+                // argv[0] => executable name
+                // argv[1] => directory name
+                for (int ii = 2; ii < argc; ii++)


-i / --input is no longer available as a batchrun command line option.
Is this intended ?

We now imply that the search directory is necessarily the first argument the user will give, and without the -i introduction.
I'm not sure of that.

I'm tempted to suggest the following command line pattern :
./batchrun -i <search dir> <the other args>, if it's doable.

indeed it only works if the study is given as the first arg
same behavior as develop, maybe open a ticket about it ?

sonarqubecloud · 2024-11-08T16:36:41Z

Quality Gate failed

Failed conditions
B Maintainability Rating on New Code (required ≥ A)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

Following comments left here #2466

cherry pick 79c3903

c433543

pull-request-size bot added the size/XL label Oct 17, 2024

payetvin added 7 commits October 17, 2024 17:00

clean cmakelists

f6b9e03

more clean

5082231

fix compile

ff6b762

fix test compile

61f6db8

logs in debug

67b5482

changelog

a8c4787

doc

c0a3976

pull-request-size bot added size/L and removed size/XL labels Oct 21, 2024

payetvin changed the title ~~8.8 solver parameters~~ 8.8 solver parameters [ANT-2280] Oct 28, 2024

JasonMarechal25 approved these changes Nov 4, 2024

View reviewed changes

pet-mit requested changes Nov 4, 2024

View reviewed changes

pet-mit requested changes Nov 7, 2024

View reviewed changes

add options transfer to batchrun

663abc3

pull-request-size bot added size/XL and removed size/L labels Nov 7, 2024

payetvin added 2 commits November 7, 2024 16:50

comment 1

9830dae

comment 2

472ddb0

pet-mit approved these changes Nov 7, 2024

View reviewed changes

guilpier-code requested changes Nov 8, 2024

View reviewed changes

remove include

17d9019

payetvin mentioned this pull request Nov 8, 2024

Few improvements to solver specific options handling #2487

Merged

payetvin merged commit 2b0ff9b into release/8.8.x Nov 8, 2024
6 of 7 checks passed

payetvin deleted the feature/8.8-solver-parameters branch November 8, 2024 16:37

flomnes pushed a commit that referenced this pull request Nov 12, 2024

Few improvements to solver specific options handling (#2487)

5e17065

Following comments left here #2466

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8.8 solver parameters [ANT-2280] #2466

8.8 solver parameters [ANT-2280] #2466

payetvin commented Oct 17, 2024 •

edited by JasonMarechal25

Loading

pet-mit Nov 4, 2024

pet-mit Nov 4, 2024

guilpier-code Nov 8, 2024

pet-mit Nov 4, 2024

pet-mit left a comment

pet-mit left a comment

guilpier-code Nov 8, 2024

payetvin Nov 8, 2024

guilpier-code Nov 8, 2024 •

edited

Loading

guilpier-code Nov 8, 2024 •

edited

Loading

payetvin Nov 8, 2024

guilpier-code Nov 8, 2024

payetvin Nov 8, 2024

sonarqubecloud bot commented Nov 8, 2024

		@@ -246,19 +127,13 @@ int main(int argc, char* argv[])
		if (not finder.list.empty())

8.8 solver parameters [ANT-2280] #2466

8.8 solver parameters [ANT-2280] #2466

Conversation

payetvin commented Oct 17, 2024 • edited by JasonMarechal25 Loading

New Module Addition:

Code Refactoring:

Error Handling Enhancements:

Documentation Updates:

Miscellaneous:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pet-mit left a comment

Choose a reason for hiding this comment

pet-mit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guilpier-code Nov 8, 2024 • edited Loading

Choose a reason for hiding this comment

guilpier-code Nov 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Nov 8, 2024

Quality Gate failed

payetvin commented Oct 17, 2024 •

edited by JasonMarechal25

Loading

guilpier-code Nov 8, 2024 •

edited

Loading

guilpier-code Nov 8, 2024 •

edited

Loading