inspect_flow.api

Python API

ConfigOptions

Options for loading a configuration file.

Source

class ConfigOptions(TypedDict, total=False)

config

Print the flow job configuration.

Source

def config(
    job: FlowJob,
    resolve: bool = False,
) -> None

job FlowJob

The flow job configuration.

resolve bool

If True, resolve the configuration before printing.

load_job

Load a job file and apply any overrides.

Source

def load_job(file: str, **kwargs: Unpack[ConfigOptions]) -> FlowJob

file str

The path to the job configuration file.

**kwargs Unpack[ConfigOptions]

Configuration options. See ConfigOptions for available parameters.

run

Run an inspect_flow evaluation.

Source

def run(
    job: FlowJob,
    dry_run: bool = False,
) -> None

job FlowJob

The flow job configuration.

dry_run bool

If True, do not run eval, but show a count of tasks that would be run.