v2 · Helpers

Legacy v2 partial application, dependency dictionaries, and formatting helpers.

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

API index

functionparams_proto.v2.partial.proto_partialSource ↗

proto_partial(proto: ParamsProto, method = False)

Overrides the function with values from the Proto Object.

Parameters

Parameter	Type / default	Description
`proto`	`ParamsProto` required	—
`method`	`—` = False	—

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

functionparams_proto.v2.utils.clean_ansiSource ↗

clean_ansi(string: str)

Parameters

Parameter	Type / default	Description
`string`	`str` required	—

functionparams_proto.v2.utils.dot_to_depsSource ↗

dot_to_deps(dot_dict, *prefixes)

Parameters

Parameter	Type / default	Description
`dot_dict`	`—` required	—
`*prefixes`	`—` variadic	—

functionparams_proto.v2.utils.read_depsSource ↗

read_deps(*path: str, should_flatten: bool = True) → dict

Read YAML configuration file with additional functionality for Fast NeRF.

path: path to the config file should_flatten: whether to flatten dicts within the config file

Dict where the config is flattened and base configuration loaded, if applicable.

Parameters

Parameter	Type / default	Description
`*path`	`str` variadic	—
`should_flatten`	`bool` = True	Keyword-only parameter.

Returns

dict

functionparams_proto.v2.utils.flattenSource ↗

flatten(nested_dict: dict, parent_key: str = '', sep: str = '.', generic_key: str = '_flatten') → dict

Flatten configuration dict. Use the "_flatten: False" key and value to flatten the dict in the YAML configuration files.

Parameters

Returns

dict