Skip to main content
Version: 25.3

snorkelflow.sdk.Benchmark

class snorkelflow.sdk.Benchmark(benchmark_uid)

Bases: object

SDK client for benchmark operations

__init__

__init__(benchmark_uid)

Initialize a Benchmark object for SDK operations

Parameters

NameTypeDefaultInfo
benchmark_uidintThe unique identifier of the benchmark.

Methods

__init__(benchmark_uid)Initialize a Benchmark object for SDK operations
export_config(filepath[, format])Export benchmark configuration to the specified format and write to the provided filepath.

export_config

export_config(filepath, format=BenchmarkExportFormat.JSON)

Export benchmark configuration to the specified format and write to the provided filepath.

Parameters

NameTypeDefaultInfo
filepathstrThe filepath to write the exported config to.
formatBenchmarkExportFormat<BenchmarkExportFormat.JSON: 'json'>The format to export the config to. Currently only JSON is supported.

Return type

None

Examples

>>> benchmark = Benchmark(123)
>>> benchmark.export_config("benchmark_config.json")