Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ui/metrics feature flags #740

Merged
merged 4 commits into from
Sep 2, 2023
Merged

Conversation

dae
Copy link
Contributor

@dae dae commented Aug 31, 2023

Partially implements #729:

  • The burn crate no longer enables the training module unless the train feature is enabled.
  • Added new flags so the UI and/or system metrics can be excluded.

textplots has two security warnings that can be avoided when the CLI
is excluded:

33 │ atty 0.2.14 registry+https://github.com/rust-lang/crates.io-index
│ ----------------------------------------------------------------- unsound advisory detected

= ID: RUSTSEC-2021-0145
= Advisory: https://rustsec.org/advisories/RUSTSEC-2021-0145
= On windows, atty dereferences a potentially unaligned pointer.

16 │ ansi_term 0.12.1 registry+https://github.com/rust-lang/crates.io-index
│ ---------------------------------------------------------------------- unmaintained advisory detected

= ID: RUSTSEC-2021-0139
= Advisory: https://rustsec.org/advisories/RUSTSEC-2021-0139
= The maintainer has advised that this crate is deprecated and will not receive any maintenance.

Pull Request Template

Checklist

  • Confirm that run-checks script has been executed.

Related Issues/PRs

#729

Copy link
Member

@nathanielsimard nathanielsimard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comments bellow. Having a cli feature flag is fine, but I would enable it by default. Also we should have a better implementation without using text-plot, probably using something like ratatui: https://github.com/ratatui-org/ratatui.

burn-train/Cargo.toml Outdated Show resolved Hide resolved
burn-train/src/metric/dashboard/plot.rs Outdated Show resolved Hide resolved
burn-train/src/metric/mod.rs Outdated Show resolved Hide resolved
burn/Cargo.toml Outdated Show resolved Hide resolved
burn/Cargo.toml Outdated Show resolved Hide resolved
@dae dae changed the title Don't enable training by default; add cli feature flag Add ui/metrics feature flags Sep 1, 2023
Copy link
Member

@nathanielsimard nathanielsimard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dae I'm still unsure about the feature flag names metrics and ui, but at least we offer the option now!

dae added 4 commits September 2, 2023 08:05
Partially implements tracel-ai#729:

- Added a new train-cli feature to enable the metric plotting/CLI
rendering.
@dae
Copy link
Contributor Author

dae commented Sep 1, 2023

Conflicts fixed . No preferences on names - some other ideas: train-tui, train-sys-metrics.

@nathanielsimard nathanielsimard merged commit d80e0d1 into tracel-ai:main Sep 2, 2023
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.

3 participants