diff --git a/examples/reporting/requirements.txt b/examples/reporting/requirements.txt index 552078da..89c90bd7 100644 --- a/examples/reporting/requirements.txt +++ b/examples/reporting/requirements.txt @@ -5,3 +5,4 @@ matplotlib >= 2.2.4 ; python_version < '3.6' numpy pandas pillow>=4.0 +six diff --git a/examples/reporting/text_reporting.py b/examples/reporting/text_reporting.py index 7e48e007..fe4fbbae 100644 --- a/examples/reporting/text_reporting.py +++ b/examples/reporting/text_reporting.py @@ -3,7 +3,9 @@ import logging import sys -from trains import Task, Logger +import six + +from trains import Logger, Task def report_logs(logger): @@ -17,27 +19,53 @@ def report_logs(logger): # this is a loguru test example try: - from loguru import logger as loguru_logger # noqa + from loguru import logger as loguru_logger # noqa - loguru_logger.info("That's it, beautiful and simple logging! (using ANSI colors)") + loguru_logger.info( + "That's it, beautiful and simple logging! (using ANSI colors)" + ) except ImportError: - print('loguru not installed, skipping loguru test') + print("loguru not installed, skipping loguru test") # report text logger.report_text("hello, this is plain text") +def report_debug_text(logger): + # type: (Logger) -> () + """ + reporting text to debug sample section + :param logger: The task.logger to use for sending the sample + """ + text_to_send = """ +Lorem ipsum dolor sit amet, consectetur adipiscing elit. +Suspendisse ac justo ut dolor scelerisque posuere. +Donec hendrerit, purus viverra congue maximus, neque orci vehicula elit, pulvinar elementum diam lorem ut arcu. +Sed convallis ipsum justo. Duis faucibus consectetur cursus. Morbi eleifend nisl vel maximus dapibus. +Vestibulum commodo justo eget tellus interdum dapibus. Curabitur pulvinar nibh vitae orci laoreet, id sodales justo ultrices. +Etiam mollis dui et viverra ultrices. Vestibulum vitae molestie libero, quis lobortis risus. Morbi venenatis quis odio nec efficitur. +Vestibulum dictum ipsum at viverra ultrices. Aliquam sed ante massa. Quisque convallis libero in orci fermentum tincidunt. +""" + logger.report_media( + title="text title", + series="text series", + iteration=1, + stream=six.StringIO(text_to_send), + file_extension=".txt", + ) + + def main(): # Create the experiment Task task = Task.init(project_name="examples", task_name="text reporting") - print('reporting text logs') + print("reporting text logs") # report regular console print - print('This is standard output test') + print("This is standard output test") # report stderr - print('This is standard error test', file=sys.stderr) + print("This is standard error test", file=sys.stderr) # Get the task logger, # You can also call Task.current_task().get_logger() from anywhere in your code. @@ -46,12 +74,15 @@ def main(): # report text based logs report_logs(logger) + # report text as debug example + report_debug_text(logger) + # force flush reports # If flush is not called, reports are flushed in the background every couple of seconds, # and at the end of the process execution logger.flush() - print('We are done reporting, have a great day :)') + print("We are done reporting, have a great day :)") if __name__ == "__main__":