tracel-ai/burn

Add a `burn-profiler` crate to evaluate performances

Open

#1,265 opened on Feb 5, 2024

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Rust (964 forks)auto 404
featuregood first issue

Repository metrics

Stars
 (15,550 stars)
PR merge metrics
 (PR metrics pending)

Description

Feature description

Besed on the bevy-log crate, the burn-profiler crate must be able to evaluate function performances and detect where the hotspots could be localized. The crate should also provide APIs to allow spans creation. A span is used to measure specific code portions and bevy profiling section can be an example:

{
  // creates a span and starts the timer
  let my_span = info_span!("span_name", name = "span_name").entered();
  do_something_here();
} // my_span is dropped here ... this stops the timer

The crate should also implement APIs to interact with external profilers such as the Tracy Profiler Trace.

Roadmap:

  • 1. Add burn-profiler spans APIs
  • 2. Document how to use these APIs in the Contributor book
  • 3. Verify if those APIs work in an async context
  • 4. Evaluate whether those APIs can work in a no_std environment

Feature motivation

Evaluating whether there are functions and methods which consumes a great amount of resources in terms of memory and computation

Contributor guide

Research direction
Implement the burn profiler crate with span creation APIs and external profiler integration, following the bevy log crate example.
Tech stack
rust
Domain
developer experienceperformancetesting
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50