Media Reporting

Trains is now ClearML

This documentation applies to the legacy Trains versions. For the latest documentation, see ClearML.

The media_reporting.py example demonstrates reporting images, audio, and video. Upload from a local path, provide a BytesIO stream, or provide the URL of media already uploaded to some storage. Use the Logger.report_media method.

Trains uploads media to the bucket specified in the Trains configuration file, or you can configure Trains for image storage, see Logger.set_default_upload_destination (storage for artifacts is different). Set credentials for storage in the Trains configuration file.

Trains reports media in the Trains Web (UI), experiment details, RESULTS tab, DEBUG SAMPLES sub-tab.

When the script runs, it creates an experiment named audio and video reporting, which is associated with the examples project.

Reporting (uploading) media from a source by URL

Report by calling the Logger.report_media method using the url parameter.

# report video, an already uploaded video media (url)
Logger.current_logger().report_media(
    'video', 'big bunny', iteration=1,
    url='https://test-videos.co.uk/vids/bigbuckbunny/mp4/h264/720/Big_Buck_Bunny_720_10s_1MB.mp4')

#  report audio, report an already uploaded audio media (url)
Logger.current_logger().report_media(
    'audio', 'pink panther', iteration=1,
    url='https://www2.cs.uic.edu/~i101/SoundFiles/PinkPanther30.wav')

image

Double click a thumbnail and the audio player opens.

Reporting (uploading) media from a local file

Use the local_path parameter.

#  report audio, report local media audio file
Logger.current_logger().report_media(
    'audio', 'tada', iteration=1,
    local_path=os.path.join('data_samples', 'sample.mp3'))

image

Double click a thumbnail and the video player opens.