You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Nov 26, 2021. It is now read-only.
Run(events=["thermal_temperature"]) reuses the event that trappy has for thermal_temperature. From a user point of view, it's unclear why trappy knows how to pivot it (or why does bart's Analyzer.getStatement() know that select should operate on the thermal zone id). Even worse, in the resulting object, the event is found in run.thermal (instead of the expected run.thermal_temperature). This is all very confusing for the new user.
We should document which classes are known by trappy.
We can keep run.thermal (and basically every class derived from Base that has a name), but we should alias it to the event name: run.thermal_temperature, run.thermal_power_cpu_limit,... All documentation should be updated to use the event names to avoid confusion and the old names should only be kept for compatibility with old notebooks. Brownie points (i.e. you win a ❤️) if we mark the old names as "deprecated".
Extra brownie points (you win 💕 💕 and a badge) if we make Run instances introspectable. That is, you can call a function to know which events are registered. Ideally the introspection tells the user which events have been parsed without the user having to look at the help of the function to understand the output. At the same time, the output should be programmatic, a program should be able to use the return value without too much hassle. Maybe something like (better proposals welcome):
In [1]: import trappy
In [2]: run = trappy.Run(events=["thermal_temperature", "thermal_power_cpu_limit"])
In [3]: run.get_events()
Out[3]:
trace_event name num_events
0 thermal_temperature thermal 249
1 thermal_power_cpu_limit cpu_in_power 152
[2 rows x 3 columns]
The text was updated successfully, but these errors were encountered:
Run(events=["thermal_temperature"])
reuses the event thattrappy
has forthermal_temperature
. From a user point of view, it's unclear why trappy knows how to pivot it (or why does bart'sAnalyzer.getStatement()
know thatselect
should operate on the thermal zone id). Even worse, in the resulting object, the event is found inrun.thermal
(instead of the expectedrun.thermal_temperature
). This is all very confusing for the new user.run.thermal
(and basically every class derived from Base that has aname
), but we should alias it to the event name:run.thermal_temperature
,run.thermal_power_cpu_limit
,... All documentation should be updated to use the event names to avoid confusion and the old names should only be kept for compatibility with old notebooks. Brownie points (i.e. you win a ❤️) if we mark the old names as "deprecated".Run
instances introspectable. That is, you can call a function to know which events are registered. Ideally the introspection tells the user which events have been parsed without the user having to look at the help of the function to understand the output. At the same time, the output should be programmatic, a program should be able to use the return value without too much hassle. Maybe something like (better proposals welcome):The text was updated successfully, but these errors were encountered: