NDL-REPORT(1)

✨ COMMAND ndl report ✨

────────────────────────────────────────

okay bestie, listen up 💖 this is the manual page for NDL — yeah, the whole NDL() manual, section 1, and we're talking about the report command specifically. It's giving "turn your test results into a whole HTML situation" and honestly? iconic. Let's go 🦋

       OUTDIR] [--exclude EXCLUDE]
       [--include INCLUDE]
       [--even-up-dp-count] [-x XAXES] [-y
       YAXES]
       [--hist HIST] [--chist CHIST]
       [--reportids REPORTIDS]
       [--report-descr REPORT_DESCR]
       [--copy-raw] [--list-metrics]

              respaths [respaths ...]

Create an HTML report for one or multiple test results. That's the whole vibe. Slay. 💅

🌸 respaths

• respaths — One or multiple ndl test result paths. Like, you can hand it just one result, or a whole lil squad of them. Your call, queen 👑

🎀 OPTIONS ndl report 🎀

• -h — Show this help message and exit. The classic "pls explain urself" button 🫶
• -q — Be quiet. Shhh 🤫 lowkey the "no thoughts, just vibes" mode.
• -d — Print debugging information. For when you need the tea ☕ every last detail, spill it.
• -o OUTDIR, --outdir OUTDIR — Path to the directory to store the report at. By default the report is stored in the ndl-report-<reportid> sub-directory of the test result directory. If there are multiple test results, the report is stored in the current directory. The <reportid> is report ID of ndl test result. So basically: one result → it nests itself all cute inside the result dir; many results → it just dumps itself right where you're standing. ✨
• --exclude EXCLUDE — Datapoints to exclude: remove all the datapoints satisfying the expression EXCLUDE. Here is an 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%. The detailed expression syntax can be found in the documentation for the eval() function of Python pandas module. You can use metrics in the expression, or the special word index for the row number (0-based index) of a datapoint in the results. For example, expression index >= 10 will get rid of all datapoints except for the first 10 ones. So it's a lil filter, and index is your bestie for "just the first N, thanks" 🙈
• --include INCLUDE — Datapoints to include: remove all datapoints except for those satisfying the expression INCLUDE. In other words, this option is the inverse of --exclude. This means, --include expr is the same as --exclude "not (expr)". Mirror mirror on the wall 🪞 it's literally the opposite, no cap.
• --even-up-dp-count — Even up datapoints count before generating the report. This option is useful when generating a report for many test results (a diff). If the test results contain different count of datapoints (rows count in the CSV file), the resulting histograms may look a little bit misleading. This option evens up datapoints count in the test results. It just finds the test result with the minimum count of datapoints and ignores the extra datapoints in the other test results. So it's like "everyone gets the same amount of snacks, nobody's histogram is doing too much" 🍓
• -x XAXES, --xaxes XAXES — A comma-separated list of metrics (or python style regular expressions matching the names) to use on X-axes of the scatter plot(s), default is LDist. Use --list-metrics to get the list of the available metrics. Use value none to disable scatter plots. X-axis glow-up, periodt 📈
• -y YAXES, --yaxes YAXES — A comma-separated list of metrics (or python style regular expressions matching the names) to use on the Y-axes for the scatter plot(s). If multiple metrics are specified for the X- or Y-axes, then the report will include multiple scatter plots for all the X- and Y-axes combinations. The default is RTD. Use --list-metrics to get the list of the available metrics. Use value none to disable scatter plots. Multiple X's and multiple Y's? Bestie that's a whole grid of scatter plots, we love a combinatorial moment 💀
• --hist HIST — A comma-separated list of metrics (or python style regular expressions matching the names) to add a histogram for, default is RTD. Use --list-metrics to get the list of the available metrics. Use value none to disable histograms. Bars. Beautiful bars. 📊
• --chist CHIST — A comma-separated list of metrics (or python style regular expressions matching the names) to add a cumulative distribution for, default is RTD. Use --list-metrics to get the list of the available metrics. Use value none to disable cumulative histograms. The cumulative version, the "how far have we come" arc 🌈
• --reportids REPORTIDS — Every input raw result comes with a report ID. This report ID is basically a short name for the test result, and it used in the HTML report to refer to the test result. However, sometimes it is helpful to temporarily override the report IDs just for the HTML report, and this is what the --reportids option does. Please, specify a comma-separated list of report IDs for every input raw test result. The first report ID will be used for the first raw rest result, the second report ID will be used for the second raw test result, and so on. Please, refer to the --reportid option description in the start command for more information about the report ID. Basically: temporary glow-up names, first-come-first-served matching, no permanent changes 💅
• --report-descr REPORT_DESCR — The report description - any text describing this report as whole, or path to a file containing the overall report description. For example, if the report compares platform A and platform B, the description could be something like

🫶 yep, the original page leaves that sentence hanging right there. Not my fault, I'm just the messenger bestie.

• --copy-raw — Copy raw test results to the output directory (unless the output direcory is already part of the raw result sub-directory). It's the "bring your receipts" option 🧚
• --list-metrics — Print the list of the available metrics and exit. The ultimate "what are my options" mood board ⭐

and that's the whole page, fr fr 💜 thanks for reading all the way to the bottom, you're a real one. This was NDL — version/date stamp: 2024-03-08, and the source line is just NDL(), section 1, serving main-character energy as always. bye bestie 👑🌸