diff --git a/docs/hyperdatasets/previews.md b/docs/hyperdatasets/previews.md index 8d4a4b3d..2b30e677 100644 --- a/docs/hyperdatasets/previews.md +++ b/docs/hyperdatasets/previews.md @@ -2,11 +2,11 @@ title: Previews --- -A `preview` is a dictionary containing metadata for optional thumbnail images that can be used in the ClearML Enterprise -WebApp (UI) to view selected images in a Dataset. `previews` includes the `uri` of the thumbnail image. +A `preview` is a dictionary containing metadata for optional thumbnail images or videos that can be used in the ClearML Enterprise +WebApp (UI) to view selected content in a Dataset. `previews` includes the `uri` of the thumbnail image or video. Previews are not mandatory. Their primary use is to view images with formats that cannot be displayed in a web browser -(such as TIFF and 3D formats). +(such as TIFF and 3D formats). ## Example @@ -88,7 +88,10 @@ The following is an example of preview metadata. -Here's an example of Previews in the ClearML Enterprise WebApp (UI). Each thumbnail is a Preview. +Here's an example of Previews in the ClearML Enterprise WebApp (UI). Each thumbnail is a Preview: ![Previews](../img/hyperdatasets/web-app/dataset_versions.png) +If the preview's `uri` is for a video, the thumbnail will display the video with video controls: + +![Video previews](../img/hyperdatasets/video_preview.png) \ No newline at end of file diff --git a/docs/img/hyperdatasets/video_preview.png b/docs/img/hyperdatasets/video_preview.png new file mode 100644 index 00000000..65f54655 Binary files /dev/null and b/docs/img/hyperdatasets/video_preview.png differ