diff --git a/docs/logger.md b/docs/logger.md index 9fd01fef..9d972927 100644 --- a/docs/logger.md +++ b/docs/logger.md @@ -11,20 +11,12 @@ Using the **TRAINS** [Logger](https://github.com/allegroai/trains/blob/master/tr * [Confusion matrices](#confusion-matrices) * [Surface diagrams](#surface-diagrams) * [Images](#images) - * [Files](#files) * Track hyper-parameters and OS environment variables * Logging experiment parameter [dictionaries](#logging-experiment-parameter-dictionaries) * Specifying [environment variables](#specifying-environment-variables-to-track) to track * Message logging - * [Debugging messages](#debugging-messages) - * [Informational messages](#informational-messages) - * [Warnings](#warnings) - * [General errors](#general-errors) - * [Critial errors](#critical-errors) - * [Fatal errors](#fatal-errors) - * [Console and logger messages](#console-and-logger-messages) * [Reporting text without formatting](#reporting-text-without-formatting) Additionally, the **TRAINS** Logger module provides methods that allow you to do the following: @@ -834,7 +826,7 @@ First [get the current logger](#get-the-current-logger) and then use it (see an **Method**: ```python -def report_image_and_upload(self, title, series, iteration, path=None, matrix=None, max_image_history=None, delete_after_upload=False) +def report_image(self, title, series, iteration, local_path=None, matrix=None, max_image_history=None, delete_after_upload=False) ``` **Arguments**: @@ -921,7 +913,7 @@ def report_image_and_upload(self, title, series, iteration, path=None, matrix=No
Parameter - | -Type - | -Description - | -Mandatory - | -
---|---|---|---|
iteration - | -integer - | -The iteration number. - | -Yes - | -
series - | -string - | -The label of the series. - | -Yes - | -
title - | -string - | -The title of the image. - | -Yes - | -
delete_after_upload - | -boolean - | -Indicates whether to delete the local copy of the file after uploading it. The values are:
-
|
- No - | -
max_file_history - | -integer - | -The maximum number of images to store per metric / variant combination. For an unlimited number of files to store, specify a negative number.
- The default value which is set in the global configuration is 5 .
- |
- No - | -
path - | -string - | -The path of the file to upload. - | -No - | -