Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tbittar committed Jan 4, 2024
1 parent fdbfaa2 commit c8ff834
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions docs/user-guide/get-started/settings-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,12 @@ The following section lists the configurable parameters. If the user does not sp
|[`master`](#master) | `integer` | Resolution mode of the master problem |
|[`yearly-weights`](#yearly-weights) | `None` | Path of the Monte-Carlo weights file |
|[`solver`](#solver) | `Cbc` | Name of the solver |
|[`log_level`](#log_level) | `0` | logs severity see tab below |
|[`log_level`](#log_level) | `0` | Logs severity |
|[`additional-constraints`](#additional-constraints) | `None` | Path of the additional constraints file |
|[`separation_parameter`](#separation_parameter) | `0.5` | Step size for the in-out separation |
|[`relaxed_optimality_gap`](#relaxed_optimality_gap) | `1e-5` | Threshold to switch from relaxed to integer master |
|[`batch_size`](#batch_size) | `0` | Number of subproblems per batch |

log display according to log_level
**** | **Operational** | **Benders** | **Solver**
-------------|------------------|-------------|------------
**File** | always | always | 2
**Console** | 0 | > 0 | never



The format is a standard `.ini` and should follow this template:
```ini
uc_type = expansion_fast
Expand Down Expand Up @@ -213,13 +205,21 @@ To use another solver, you have to build the package with the chosen solver, ple

### `log_level`

Positive integer, specifying the `solver`'s log severity. Default value: `0`.
Possible values :`{0, 1, 2}`, specifying the `solver`'s log severity. Default value: `0`.

Logs can be printed both in the console and in a file. There are 3 types of logs:

- **Operational**: Displays progress information for the investment on candidates and costs,
- **Benders**: Displays information on the progress of the Benders algorithm,
- **Solver**: Logs of the solver called for the resolution of each master or subproblem.

For now two log levels are available:
The table below details the behavior depending on the `log_level`.

- If `log_level = 0`: basic solver logs are printed.
| | **Operational** | **Benders** | **Solver**
|-------------|------------------------------|-------------|------------
| **File** | Always `(reportbenders.txt)` | Always `(benders_solver.log)` | 2 `(solver_log_proc_<proc_num>.txt)`
| **Console** | 0 | >= 1 | Never

- If `log_level > 0`: full logs are printed simultaneously in standard output and in `benders.log` file located in the `lp` folder.

### `additional-constraints`

Expand Down

0 comments on commit c8ff834

Please sign in to comment.