MetadataOptions

class MetadataOptions(**kwargs)

Bases: Section

Options for metadata generator.

Parameters:

• config (Mapping[str, Any] | None)

• init_subsections (bool)

• kwargs (Any)

add_git_info: Bool

• Default value: True

If True add information about git repository status.

add_params: Bool

• Default value: True

If True add parameters (either as dict or str).

creation_script: Unicode | None

• Default value: None

Manually specify the creation script.

git_ignore: List[Unicode]

• Default value: []

Files and folders to ignore when creating git diff.

max_diff_lines: Int

• Default value: 30

Maximum number of lines to include in diff.

methods: List[Unicode] | None

• Default value: None

Manually specify methods to run. If left to None, all methods are run.

methods_to_skip = {'add_git_info': ['creation_commit', 'creation_diff'], 'add_params': ['creation_params']}

Mapping of trait options to lists of methods to skip if that option is False.

params_exclude: List[Unicode]

• Default value: ['log_']

Prefixes of parameters to exclude from metadata attribute.

params_str: Bool

• Default value: True

If True, serialize parameters using JSON.