WULT-FILTER(1)

💖 WULT-FILTER 💖

okay bestie so this is the manual page for wult filter, from the WULT manual, and it's dated 2024-03-08 in case you were wondering when we last touched grass (we did not, we were filtering datapoints 🫶).

✨ COMMAND wult filter ✨

here's the whole vibe in one block, no cap:

usage: wult filter [-h] [-q] [-d] [--exclude EXCLUDE] [--include
       INCLUDE] [--exclude-metrics MEXCLUDE] [--include-metrics MINCLUDE]
       [--human-readable] [-o OUTDIR] [--list-metrics] [--reportid REPORTID]
       respath

so like, this command filters datapoints out of a test result — it straight-up deletes CSV rows and metrics based on whatever criteria you give it. 💅

the criteria? you tell it using the row filter and metric filter/selector options (--include, --exclude-metrics, etc). and the way that you can pass those options multiple times? iconic. obsessed.

• respath — the path to the wult test result you wanna filter. that's it, that's the whole argument. 🌸

🎀 OPTIONS wult filter 🎀

one bullet per option, we do not skip, we do not play:

• -h — show this help message and then dip. bye bestie. 👋
• -q — be quiet. shhh. 🤫
• -d — print debugging information. it's giving verbose main character energy. 🔍
• --exclude EXCLUDE — datapoints to exclude: nuke every datapoint that satisfies the expression EXCLUDE. here's a whole example of an expression:

(WakeLatency < 10000) | (PC6% < 1)

this filter expression will remove all datapoints with WakeLatency smaller than 10000 nanoseconds or package C6 residency smaller than 1%. periodt. the detailed expression syntax lives in the documentation for the eval() function of the Python pandas module — go read that, iykyk. you can use metrics in the expression, or the special word index for the row number (that's the 0-based index) of a datapoint in the results. for example, the expression index >= 10 will get rid of all datapoints except for the first 10 ones. slay. 🔥

• --include INCLUDE — datapoints to include: remove all datapoints except the ones satisfying the expression INCLUDE. in other words, this option is literally the inverse of --exclude. which means --include expr is the same as --exclude "not (expr)". math is math. 💜
• --exclude-metrics MEXCLUDE — the metrics to exclude. it expects a comma-separated list of metrics, or python-style regular expressions that match the names. for example, the expression SilentTime,WarmupDelay,.*Cyc would remove metrics SilentTime, WarmupDelay, and all metrics with Cyc in their name. use --list-metrics to get the list of available metrics (yes, we're linking you to another option, we're helpful like that 🎀).
• --include-metrics MINCLUDE — the metrics to include: remove all metrics except the ones specified by this option. the syntax is the exact same as for --exclude-metrics. twin behavior, fr fr. ✨
• --human-readable — by default the result filter command prints the result as a CSV file to the standard output. this option lets you dump the result in a more human-readable form instead, because sometimes CSV is giving robot and we need giving readable. 🙈
• -o OUTDIR, --outdir OUTDIR — by default the resulting CSV lines get printed to the standard output. but this option lets you specify the output directory to store the result at. this will create a filtered version of the input test result. cute, right? 🦋
• --list-metrics — print the list of the available metrics and exit. that's the whole job. 👑
• --reportid REPORTID — report ID of the filtered version of the result. ⚠️ heads up bestie: this can only be used with --outdir. no --outdir, no --reportid, that's the rule.

🚨 reminder to my favorite person: options like --exclude, --include, --exclude-metrics and --include-metrics can be given multiple times, so don't hold back. also --reportid genuinely only works alongside --outdir — no exceptions, no vibes-based loopholes. 💀

and that's the whole page, bestie! 🌈 from the WULT manual, FILTER, dated 2024-03-08. go filter something and feel like the main character, because you are. 💅✨🫶