markdown
- Model.markdown(parameters: Parameters | None = None, initial_parameters: Parameters | None = None, base_heading_level: int = 1) MarkdownStr [source]
Format the model as Markdown string.
Parameters will be included if specified.
- Parameters:
parameters (Parameters | None) – Parameter to include.
initial_parameters (Parameters | None) – Initial values for the parameters.
base_heading_level (int) –
Base heading level of the markdown sections.
E.g.:
If it is 1 the string will start with ‘# Model’.
If it is 3 the string will start with ‘### Model’.
- Return type: