Skip to content

Commit 4ee41a6

Browse files
docs: Make note about required packages for visualization (#603)
Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
1 parent 664ec82 commit 4ee41a6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/src/logging-visualization.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ converted to a `Val` for dispatch purposes
1818
(i.e. `render_logs(logs::Dict, :myrenderer)` -> `render_logs(logs, Val{:myrenderer}())`).
1919

2020
Built-in `IO` support exists for:
21-
- `show_logs(io, logs, :graphviz)` to write a Graphviz dot graph of executed tasks and their dependencies
22-
- `show_logs(io, logs, :chrome_trace)` to write a task execution timeline in the chrome-trace format (view in [perfetto web UI](https://ui.perfetto.dev/) or `about:tracing` in a chrome-based browser)
21+
- `show_logs(io, logs, :graphviz)` to write a Graphviz dot graph of executed tasks and their dependencies (requires `GraphViz.jl` to be loaded)
22+
- `show_logs(io, logs, :chrome_trace)` to write a task execution timeline in the chrome-trace format (view in [perfetto web UI](https://ui.perfetto.dev/) or `about:tracing` in a chrome-based browser) (requires `JSON3.jl` to be loaded)
2323

2424
Built-in rendering support exists for:
25-
- `render_logs(logs, :graphviz)` to generate a graph diagram of executed tasks and their dependencies
26-
- `render_logs(logs, :plots_gantt)` to generate a Gantt chart of task execution across all processors
25+
- `render_logs(logs, :graphviz)` to generate a graph diagram of executed tasks and their dependencies (requires `GraphViz.jl` to be loaded)
26+
- `render_logs(logs, :plots_gantt)` to generate a Gantt chart of task execution across all processors (requires `Plots.jl` and `DataFrames.jl` to be loaded)
2727
- `render_logs(logs, :chrome_trace)` to generate a `String` with chrome-trace formatted task execution timeline
2828

2929
The latter (`MultiEventLog`) allows for continuously rendering logs as they're

0 commit comments

Comments
 (0)