v1 · Sweeps

Legacy v1 sweep construction, iteration, and supporting utilities.

These compatibility APIs ship with the selected source version. See the compatibility overview for other v1/v2 APIs, or migration when upgrading.

API index

Name	Kind	Defined in
`dot_join`	function	`params_proto.v1.hyper`
`key_items`	function	`params_proto.v1.hyper`
`ProxyObject`	class	`params_proto.v1.hyper`
`flatten_items`	function	`params_proto.v1.hyper`
`Sweep`	class	`params_proto.v1.hyper`
`sweep`	singleton	`params_proto.v1.hyper`

params_proto.v1.hyper

`dot_join`

functionparams_proto.v1.hyper.dot_joinSource ↗

dot_join(*keys)

remove Nones from the keys, but not '',

Parameters

Parameter	Type / default	Description
`*keys`	`—` variadic	—

`key_items`

functionparams_proto.v1.hyper.key_itemsSource ↗

key_items(d, prefix = None)

Takes in tuples of [key, value], or [None, [[key, value], ...]] returns wtf

Parameters

Parameter	Type / default	Description
`d`	`—` required	—
`prefix`	`—` = None	—

`ProxyObject`

classparams_proto.v1.hyper.ProxyObjectSource ↗

ProxyObject(hook, prefix = None)

Bases: object

Parameters

Parameter	Type / default	Description
`hook`	`—` required	—
`prefix`	`—` = None	—

`ProxyObject.init`

methodparams_proto.v1.hyper.ProxyObject.__init__Source ↗

ProxyObject.__init__(hook, prefix = None)

Parameters

Parameter	Type / default	Description
`hook`	`—` required	—
`prefix`	`—` = None	—

`flatten_items`

functionparams_proto.v1.hyper.flatten_itemsSource ↗

flatten_items(row) → Iterable[Item]

Parameters

Parameter	Type / default	Description
`row`	`—` required	—

Returns

Iterable[Item]

`Sweep`

classparams_proto.v1.hyper.SweepSource ↗

Sweep()

`Sweep.init`

methodparams_proto.v1.hyper.Sweep.__init__Source ↗

Sweep.__init__()

`Sweep.set_param`

methodparams_proto.v1.hyper.Sweep.set_paramSource ↗

Sweep.set_param(name, params, prefix = None)

Parameters

Parameter	Type / default	Description
`name`	`—` required	—
`params`	`—` required	—
`prefix`	`—` = None	—

`Sweep.product`

methodparams_proto.v1.hyper.Sweep.productSource ↗

Sweep.product(Strut: T) → ContextManager[T]

Parameters

Parameter	Type / default	Description
`Strut`	`T` required	—

Returns

ContextManager[T]

`Sweep.zip`

methodparams_proto.v1.hyper.Sweep.zipSource ↗

Sweep.zip(Strut: T) → ContextManager[T]

Parameters

Parameter	Type / default	Description
`Strut`	`T` required	—

Returns

ContextManager[T]

`Sweep.set`

methodparams_proto.v1.hyper.Sweep.setSource ↗

Sweep.set(Strut: T) → ContextManager[T]

Parameters

Parameter	Type / default	Description
`Strut`	`T` required	—

Returns

ContextManager[T]

`sweep`

callable singletonparams_proto.v1.hyper.sweepSource ↗

sweep = Sweep()

`sweep.init`

methodparams_proto.v1.hyper.sweep.__init__Source ↗

sweep.__init__()

`sweep.set_param`

methodparams_proto.v1.hyper.sweep.set_paramSource ↗

sweep.set_param(name, params, prefix = None)

Parameters

Parameter	Type / default	Description
`name`	`—` required	—
`params`	`—` required	—
`prefix`	`—` = None	—

`sweep.product`

methodparams_proto.v1.hyper.sweep.productSource ↗

sweep.product(Strut: T) → ContextManager[T]

Parameters

Parameter	Type / default	Description
`Strut`	`T` required	—

Returns

ContextManager[T]

`sweep.zip`

methodparams_proto.v1.hyper.sweep.zipSource ↗

sweep.zip(Strut: T) → ContextManager[T]

Parameters

Parameter	Type / default	Description
`Strut`	`T` required	—

Returns

ContextManager[T]

`sweep.set`

methodparams_proto.v1.hyper.sweep.setSource ↗

sweep.set(Strut: T) → ContextManager[T]

Parameters

Parameter	Type / default	Description
`Strut`	`T` required	—

Returns

ContextManager[T]

Public imports

These symbols are available from this module. Their definitions are documented in the linked modules.

is_private — params_proto.v2.proto.is_private