huggingface / huggingface/ratchet

User Reporting Util

Open
#182 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
771
Forks
44
Avg merge
40m
Merged PRs (30d)
1

Description

Due to the wide swathe of devices we can run on, we need a concrete way for users to report what system they're on, and the performance they're getting.

Users should be able to generate a report very easily from their run.

Some ideas:
1. `wgpu-info` - give full details of adapter and device.
2. [Profiler](https://github.com/huggingface/ratchet/blob/master/crates/ratchet-core/src/gpu/profiler.rs) - We already have this cool profiler that says which kernels are taking the longest, however it currently runs for every compute pass. Perhaps some way to produce an aggregate report would be better.

Contributor guide

Open the contributing guide

Research direction

Start by reading crates/ratchet-core/src/gpu/profiler.rs and reviewing the wgpu-info idea in the issue. Determine how a user could generate a report from a run, including adapter and device details and aggregate kernel timing. Done means the reporting approach and its output are defined and usable from a run.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
performance
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.