markdown

Result.markdown(with_model: bool = True, *, base_heading_level: int = 1, wrap_model_in_details: bool = False) → MarkdownStr[source]

Format the model as a markdown text.

Parameters:

  • with_model (bool) – If True, the model will be printed with initial and optimized parameters filled in.

  • base_heading_level (int) – The level of the base heading.

  • wrap_model_in_details (bool) – Wraps model into details tag. Defaults to False

Returns:

MarkdownStr – The scheme as markdown string.

Return type:

str