Skip to content

Commit ec57f3b

Browse files
authored
Match MicroProfiler docs to behavior (#2340)
The MicroProfiler was updated in PR #1835 to abort when the event arrays fill up rather than wrap around. This PR updates the documentation to match the behavior. BUG=#2272
1 parent b654b1b commit ec57f3b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

tensorflow/lite/micro/micro_profiler.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class MicroProfiler : public MicroProfilerInterface {
4040
// only once per event_handle.
4141
//
4242
// If EndEvent is called more than once for the same event_handle, the last
43-
// call will be used as the end of event marker.If EndEvent is called 0 times
43+
// call will be used as the end of event marker. If EndEvent is called 0 times
4444
// for a particular event_handle, the duration of that event will be 0 ticks.
4545
virtual void EndEvent(uint32_t event_handle) override;
4646

@@ -66,9 +66,9 @@ class MicroProfiler : public MicroProfilerInterface {
6666
void LogTicksPerTagCsv();
6767

6868
private:
69-
// Maximum number of events that this class can keep track of. If we call
70-
// AddEvent more than kMaxEvents number of times, then the oldest event's
71-
// profiling information will be overwritten.
69+
// Maximum number of events that this class can keep track of. The
70+
// MicroProfiler will abort if AddEvent is called more than kMaxEvents number
71+
// of times. Increase this number if you need more events.
7272
static constexpr int kMaxEvents = 4096;
7373

7474
const char* tags_[kMaxEvents];

0 commit comments

Comments
 (0)