Skip to content

[DOCS] Update README with fork changelog since 3c4264d#30

Merged
VincentG1234 merged 1 commit into
mainfrom
docs/readme-fork-changelog
Jun 9, 2026
Merged

[DOCS] Update README with fork changelog since 3c4264d#30
VincentG1234 merged 1 commit into
mainfrom
docs/readme-fork-changelog

Conversation

@VincentG1234

Copy link
Copy Markdown
Collaborator

Summary

Refresh README.md to document everything delivered on the InseeFrLab fork
since baseline commit 3c4264d (CI setup): execution, optimization, GuideLLM
benchmarking, bug fixes, tooling/docs, and testing.

Why

The README still described aspirational roadmap items (e.g. test suite, Ray
optional) as future work, while most of that work is already merged. New
users and contributors had no single place to see what the fork adds over
upstream.

What changed

  • README.md — add What's changed since the fork (grouped changelog with PR/issue links)
  • README.md — expand Features, Quick Start (validate, Optuna Dashboard), Documentation (AGENTS.md)
  • README.md — split Roadmap into completed / in progress / future

How tested

  • ruff check .
  • pytest -v tests/
  • Manual E2E (maintainer): not required (docs-only PR)

Risks / limitations

  • Changelog is anchored to commit 3c4264d; future README updates should extend this section or move to a CHANGELOG.md if it grows too large.
  • Links reference merged PRs/issues; no runtime behavior change.

Links

  • (none — no issue closed)

Document all InseeFrLab changes since the fork baseline (local backend,
custom metrics, grid auto-switch, GuideLLM options, Optuna dashboard,
testing/CI) and refresh Features, Quick Start, and Roadmap.

Signed-off-by: Vincent Gimenes <vincent.gimenes@gmail.com>
@VincentG1234 VincentG1234 merged commit 05b8b87 into main Jun 9, 2026
7 checks passed
@VincentG1234 VincentG1234 deleted the docs/readme-fork-changelog branch June 9, 2026 13:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant