PerfCheckerPluto full API

This reference renders the actual Julia docstrings of PerfCheckerPluto 1.0.1 with Core from the selected source revision. Notebook generation and Pluto startup are separate actions. Rendering these docstrings performs neither action.

The public API contains exported entry points. Full API also includes documented internal bindings.

PerfCheckerPluto.PerfCheckerPluto Module

Pluto notebook generation and launch for PerfChecker suites and investigations. The exported functions extend PerfChecker's shared entry points. Notebook generation writes source only; launch and measurement controls are explicit.

source

Index

• PerfCheckerPluto.PerfCheckerPluto
• PerfChecker.launch_pluto_dashboard
• PerfChecker.prepare_pluto_dashboard
• PerfChecker.write_investigation_notebook
• PerfChecker.write_suite_notebook

Docstrings

PerfChecker.launch_pluto_dashboard Method

launch_pluto_dashboard(path::AbstractString; kwargs...)

Open an existing notebook with Pluto.run and return its result. Resolve path from the working directory and reject a missing file before starting Pluto. Additional keywords go to Pluto.run, including its server configuration. This function starts a notebook server and normal Pluto cell evaluation; it does not generate the notebook or install its dependencies. Use prepare_pluto_dashboard or a notebook writer first, with a prepared controller project. Load PerfCheckerPluto to enable this method.

source

PerfChecker.prepare_pluto_dashboard Method

prepare_pluto_dashboard(path::AbstractString; suite_path=nothing,
                        factory=:build_suite, kwargs...) -> String

Write a suite controller notebook and return its absolute path. suite_path and factory select the suite definition; other keywords go to write_suite_notebook, including the prepared project, report paths and force=false overwrite policy. This function creates parent directories but does not start Pluto, install packages or run measurements. Generated cells activate the selected project when opened. Without a suite path, the notebook reads saved reports only.

using PerfChecker, PerfCheckerPluto
notebook = prepare_pluto_dashboard("perf/notebooks/results.jl";
    project=abspath("perf/pluto"), result_path="../results/suite-result.json")
# launch_pluto_dashboard(notebook) starts Pluto explicitly.

source

PerfChecker.write_investigation_notebook Method

write_investigation_notebook(path::AbstractString; root=pwd(),
    catalog=joinpath(root, "perf", "scenarios.toml"), project=root, force=false) -> String

Write an investigation controller notebook and return its absolute path. Refuse an existing file unless force=true; validate generated cell syntax before creating parent directories and writing the file. Relative root, catalog and project paths are resolved from the caller's working directory.

The selected project must already provide PerfChecker, PerfCheckerPluto and PlutoUI, plus any dependencies needed by the chosen actions. Generated cells activate that project and load the catalog when opened; a missing catalog gives an empty scenario selection. Writing the notebook does not install packages, start Pluto, run targets or contact an advisor. Launch, Cancel and advisor setup actions are explicit controls; changing a selector does not launch work.

using PerfChecker, PerfCheckerPluto
notebook = write_investigation_notebook("perf/notebooks/investigation.jl";
    root=pwd(), project=abspath("perf/pluto"))
# launch_pluto_dashboard(notebook) starts Pluto explicitly.

source

PerfChecker.write_suite_notebook Method

write_suite_notebook(path; result_path="results/suite-result.json",
                     suite_path=nothing, factory=:build_suite,
                     profile=:quick, project=active_project_directory,
                     reports_root="results/notebook", force=false)

Create a Pluto controller with package, workload, collector and target filters. Changing a selector never starts a measurement: Launch, Cancel, Refresh and Save are explicit buttons. A notebook without suite_path only reads saved reports. project identifies the prepared controller environment; it need not be the notebook directory. Relative report paths are resolved beside the notebook; relative suite paths are resolved from the caller's working directory.

Return the absolute notebook path. Refuse to overwrite an existing file unless force=true; validate generated cell syntax, create parent directories and write the notebook. Generation does not install dependencies, start Pluto or execute the suite. On opening, cells activate project and, when supplied, load the suite factory and build its plan. The controller project must already contain PerfChecker and PlutoUI; plotting also needs PerfCheckerMakie and WGLMakie.

source