The following is a quick reference for the Markdown syntax that can be used in ClearML Reports.

Embedded Visualizations

You can embed most ClearML plots and images appearing in experiments (or experiment comparison). Each such asset will show a "Copy embed code" button on hover, which will copy specific HTML embed code that, pasted in a report, will embed that asset.

<iframe src="/widgets?type=scalar&tasks=e-f6b6632fdd3648d1948fb311baaa3d03&metrics=train&company=aec6c91852c548158a76778aa40c1772" name="c66c0fda-5196-4d5f-ab0d-50ead9cb8738" width="100%" height="400"></iframe>

The rendered output looks like this:

Training loss
Training loss from the Pytorch MNIST example

Heading

# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6

The rendered output looks like this:

H1

H2

H3

H4

H5
H6

Emphasis

**This is bold text** and __so is this__ *This is italic text* and _so is this_ ~~Strikethrough~~

The rendered output looks like this:

This is bold text and so is this

This is italic text and so is this

Strikethrough

Blockquotes

> Blockquotes can be nested... >> ...by using additional greater-than signs right next to each other... > > > ...or with spaces between arrows.

The rendered output looks like this:

Blockquotes can be nested...

...by using additional greater-than signs right next to each other...

...or with spaces between arrows.

List

Unordered

+ Create a list by starting a line with `+`, `-`, or `*` + Sub-lists are made by indenting 2 spaces: - Marker character change forces new list start: * Ac tristique libero volutpat at + Facilisis in pretium nisl aliquet - Nulla volutpat aliquam velit + [x] Checkmarks are supported as well.

The rendered output looks like this:

  • Create a list by starting a line with +, -, or *
  • Sub-lists are made by indenting 2 spaces:
    • Marker character change forces new list start:
      • Ac tristique libero volutpat at
      • Facilisis in pretium nisl aliquet
      • Nulla volutpat aliquam velit
  • Checkmarks are supported as well.

Ordered

1. Start with a numbered element... 2. And just keep going. 1. You can use sequential numbers... 1. ...or keep all the numbers as `1.`

The rendered output looks like this:

  1. Start with a numbered element...
  2. And just keep going.
  3. You can use sequential numbers...
  4. ...or keep all the numbers as 1.

Tables

| | Align Right | Align Left | Align Center | | —————-—— | —————————-—:|:—————————- |:—————————-——:| | 1 | 1 | 1 | 1 | | 11 | 11 | 11 | 11 |

The rendered output looks like this:

Align Right Align Left Align Center
1 1 1 1
11 11 11 11

Collapsible sections

<details> <summary>Extra detailed information</summary> All the gory details! </details>

The rendered output looks like this:

Extra detailed information All the gory details!

Code

Inline code

Putting `code` in the middle of the sentence

The rendered output looks like this:

Putting code in the middle of the sentence


Block code with indentation

    // Comment
    line 1
    line 2
    line 3

The rendered output looks like this:

// Comment line 1 line 2 line 3

Block code using "fences"

```
Meaningful code
```

The rendered output looks like this:

Meaningful code

Syntax highlighting

```py from clearml import task t = task.Init(project_name='Groundbreaking research', task_name='Baseline') ```

The rendered output looks like this:

from clearml import task t = task.Init(project_name='Groundbreaking research', task_name='Baseline')

Links

[link text](http://ww.clear.ml) [link with tooltip](http://www.clear.ml/docs/latest/docs/ "ClearML Documentation")

The rendered output looks like this:

link text

link with tooltip

Horizontal Rules

___ --- ***

The rendered output looks like this:




Images

![Logo with text](c-logomark.svg "ClearML Logo with title")

The rendered output looks like this:

Logo with text