🤖 Tutorials deployment from 8b527f4a0fbf82ffe8ca2b677efa2b327fe19346 (#204)

Co-authored-by: JSOTutorials bot <[email protected]>

Author: abelsiqueira

tutorials/introduction-to-benchmarkprofiles/figures/index_1_1.png

@@ -5,17 +5,31 @@
 \preamble{Abel Soares Siqueira and Dominique Orban}
 
 
-![JSON 0.21.3](https://img.shields.io/badge/JSON-0.21.3-000?style=flat-square&labelColor=999)
-[![BenchmarkProfiles 0.4.3](https://img.shields.io/badge/BenchmarkProfiles-0.4.3-006400?style=flat-square&labelColor=389826)](https://juliasmoothoptimizers.github.io/BenchmarkProfiles.jl/stable/)
-![Plots 1.38.5](https://img.shields.io/badge/Plots-1.38.5-000?style=flat-square&labelColor=999)
+![JSON 0.21.4](https://img.shields.io/badge/JSON-0.21.4-000?style=flat-square&labelColor=999)
+[![BenchmarkProfiles 0.4.6](https://img.shields.io/badge/BenchmarkProfiles-0.4.6-006400?style=flat-square&labelColor=389826)](https://jso.dev/BenchmarkProfiles.jl/stable/)
+![Plots 1.41.1](https://img.shields.io/badge/Plots-1.41.1-000?style=flat-square&labelColor=999)
+![Random 1.11.0](https://img.shields.io/badge/Random-1.11.0-000?style=flat-square&labelColor=999)
 
 
 
-This tutorial is essentially a collection of examples.
+This tutorial demonstrates how to use BenchmarkProfiles.jl to visualize and compare solver performance across multiple test problems.
 
 ## Performance Profile
 
-Performance profiles are straightforward to use. The input is a matrix `T` with entries `T[i,j]` indicating the cost to solve problem `i` using solver `j`. Cost can be, for instance, elapsed time, or number of evaluations. The cost should be positive. If any cost is zero, all measures will be shifted by 1.
+Performance profiles, introduced by Dolan and Moré (2002), provide a graphical way to compare the performance of multiple solvers across a test set. They show the fraction of problems solved by each solver as a function of a performance tolerance.
+
+### Understanding Performance Profiles
+
+The input is a matrix `T` with entries `T[i,j]` indicating the cost to solve problem `i` using solver `j`. Cost can be, for instance, elapsed time, number of iterations, or function evaluations. The cost should be positive. If any cost is zero, all measures will be shifted by 1.
+
+The performance profile plots:
+- **x-axis (τ)**: Performance ratio - how much slower a solver is compared to the best solver for each problem. τ=1 means the solver was fastest, τ=2 means it took twice as long as the fastest solver.
+- **y-axis (ρ(τ))**: Fraction of problems solved within the performance ratio τ. ρ(2) = 0.8 means the solver solved 80% of problems within twice the time of the best solver.
+
+**Key interpretations**:
+- The height at τ=1 (left side) shows the fraction of problems where the solver was fastest
+- The right-side height (as τ→∞) shows the fraction of problems successfully solved (robustness)
+- Higher curves are better - the solver solves more problems with smaller performance ratios
 
 Basic usage:
 
@@ -54,9 +68,19 @@ performance_profile(PlotsBackend(), T, ["Solver 1", "Solver 2", "Solver 3"])
 
 
 
+### Customization Options
+
 `Plots` arguments can be passed to `performance_profile()` or used as they normally would be with `Plots`.
 In the example below, we pass `xlabel` to `performance_profile` and set `ylabel` through `ylabel!`.
 
+Common customization options:
+- `lw`: Line width
+- `c` or `color`: Line colors
+- `linestyles`: Line styles (`:solid`, `:dash`, `:dot`, etc.)
+- `xlabel`, `ylabel`: Axis labels
+- `title`: Plot title
+- `legend`: Legend position (e.g., `:bottomright`, `:topleft`)
+
 ```julia
 using Plots
 
@@ -67,3 +91,15 @@ ylabel!("ρ(τ)")
 ```
 
 ![](figures/index_4_1.png)
+
+
+
+### Additional Parameters
+
+The `performance_profile` function accepts several optional keyword arguments:
+
+- `logscale::Bool=true`: Use logarithmic scale on the x-axis (default: true). Useful for viewing performance across a wide range of ratios.
+- `sampletol::Number=0`: Tolerance for sampling data points. Can reduce plot complexity for large datasets.
+- `title::String=""`: Title for the plot
+
+For more details on performance profiles, see: Dolan, E. D., & Moré, J. J. (2002). Benchmarking optimization software with performance profiles. Mathematical Programming, 91(2), 201-213.