Fix/update benchmarks

.gitignore

@@ -1,5 +1,11 @@
-# Project-specific
-benchmark_output/
+# Benchmark outputs, only track docs/results.csv and docs/config.yaml
+glum_benchmarks/results/*
+!glum_benchmarks/results/docs/
+!glum_benchmarks/results/docs/**
+glum_benchmarks/results/docs/*
+!glum_benchmarks/results/docs/results.csv
+!glum_benchmarks/results/docs/config.yaml
+glum_benchmarks/.cache/
 
 # Files created by templating
 dense.cpp
@@ -137,9 +143,6 @@ mlruns
 *.pdf
 *.lprof
 
-# GLM_BENCHMARKS_CACHE
-cache
-
 # pkgs
 pkgs/*
 

.pre-commit-config.yaml

@@ -41,7 +41,7 @@ repos:
       - id: mypy
         name: mypy
         entry: pixi run -e default mypy
-        exclude: (^tests/|^src/glum_benchmarks/orig_sklearn_fork/)
+        exclude: ^tests/
         language: system
         types: [python]
         require_serial: true

README.md

@@ -24,8 +24,10 @@ The goal of `glum` is to be at least as feature-complete as existing GLM librari
 
 This repo also includes tools for benchmarking GLM implementations in the `glum_benchmarks` module. For details on the benchmarking, [see here](src/glum_benchmarks/README.md). Although the performance of `glum` relative to `glmnet` and `h2o` depends on the specific problem, we find that when N >> K (there are more observations than predictors), it is consistently much faster for a wide range of problems.
 
+<!-- BENCHMARK_FIGURES_START -->
 ![Performance benchmarks](docs/_static/headline_benchmark.png#gh-light-mode-only)
 ![Performance benchmarks](docs/_static/headline_benchmark_dark.png#gh-dark-mode-only)
+<!-- BENCHMARK_FIGURES_END -->
 
 For more information on `glum`, including tutorials and API reference, please see [the documentation](https://glum.readthedocs.io/en/latest/).
 

docs/benchmarks.rst

@@ -9,6 +9,8 @@ Note that glum was originally developed to solve problems where N >> K (number o
 
 If a bar goes out of the range of the chart, the exact runtime is printed on the bar with an arrow indicating that the bar is truncated.
 
+.. BENCHMARK_FIGURES_START
+
 .. image:: _static/narrow-insurance-l2.png
    :width: 700
 .. image:: _static/narrow-insurance-lasso.png
@@ -28,3 +30,5 @@ Note that the ``r-glmnet`` result for the ``wide-insurance-ridge`` Poisson bench
    :width: 700
 .. image:: _static/intermediate-housing-lasso.png
    :width: 700
+
+.. BENCHMARK_FIGURES_END