Add option to request manual quit on tui

[vincentmasse]

Pull Request Template

Checklist

• Confirmed that run-checks all script has been executed.
• Made sure the book is up to date with changes in this PR.

Related Issues/PRs

#2233

Changes

Add option to learner builder to wait for user to quit the renderer.

Testing

Manual test, TUI waits for q to close.

[vincentmasse]

I wasn't sure about the best way to implement this, particularly if adding it to the builder was the right approach. Let me know if you have any suggestions.

[vincentmasse]

I got this error while running run_checks. I opened the PR since it's not linked with the changes I made. I suspect it's because the intel graphics used isn't implementing cooperative matrix multiplication.

[codecov]

Codecov Report

Attention: Patch coverage is 0% with 45 lines in your changes missing coverage. Please review.

Project coverage is 82.56%. Comparing base (94db460) to head (b417f3a).
Report is 24 commits behind head on main.

Files with missing lines	Patch %	Lines
crates/burn-train/src/renderer/tui/renderer.rs	0.00%	45 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2489      +/-   ##
==========================================
- Coverage   82.94%   82.56%   -0.38%     
==========================================
  Files         811      827      +16     
  Lines      105059   106757    +1698     
==========================================
+ Hits        87136    88143    +1007     
- Misses      17923    18614     +691     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[laggui]

I think that's a great start! But I have a couple of general comments.

First, I'm not sure adding with_manual_quit is the best 🤔 especially since it doesn't apply to all renderers.

Instead, I think this could simply be added as an option for the TuiMetricsRenderer and users could explicitly provide the renderer in with_renderer(...) (at least for now).

Another thing I noticed is that it's not always clear when the training is done when keeping the TUI opened, especially if early stopping is used. Haven't had the time to look into it as much but it should be taken into consideration.

[laggui]

Ah that's pretty good!

I think we could make one minimal change, after which the usage would look something like this:

let learner = LearnerBuilder::new(ARTIFACT_DIR)
    // ...
    .devices(vec![device.clone()])
    .num_epochs(config.num_epochs)
    .summary();

let tui = TuiMetricsRenderer::new(learner.interrupter(), None).persistent();
let learner = learner
    .renderer(tui)
    .build(Model::new(&device), config.optimizer.init(), 1e-4);

While it "breaks" the builder pattern, I think it's perfectly fine for now. We could eventually improve this but I don't think it's a critical issue atm.