From f047245e7f8d389cee8ed6a6735e1912c5634c73 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Thu, 15 Jul 2021 09:54:58 +0300 Subject: [PATCH] Add offline mode FAQ (#14) --- docs/faq.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/faq.md b/docs/faq.md index 77f849b0..9c7ab1a9 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -30,6 +30,7 @@ title: FAQ * [In the Web UI, I can't access files that my experiment stored. Why not?](#access_files) * [I get the message "ClearML Monitor: Could not detect iteration reporting, falling back to iterations as seconds-from-start". What does it mean?](#resource_monitoring) * [Can I control what ClearML automatically logs?](#controlling_logging) +* [Can I run a ClearML Task while working offline?](#offline_mode) **Graphs and Logs** @@ -383,6 +384,22 @@ When initializing a Task by calling the `Task.init` method, provide the `auto_co framework logging, and the `auto_connect_streams` parameter to control `stdout`, `stderr`, and standard logging. The values are `True`, `False`, and a dictionary for fine-grain control. See [Task.init](references/sdk/task.md#classmethod-initproject_namenone-task_namenone-task_typetasktypestraining-training-tagsnone-reuse_last_task_idtrue-continue_last_taskfalse-output_urinone-auto_connect_arg_parsertrue-auto_connect_frameworkstrue-auto_resource_monitoringtrue-auto_connect_streamstrue). + +
+ + +**Can I run ClearML Task while working offline?** + +Yes! You can use ClearML's Offline Mode, in which all the data and logs that a task captures from the code are stored in a +local folder + +Before initializing a task, use the [Task.set_offline](references/sdk/task.md#taskset_offline) +class method and set the `offline_mode` argument to `True`. When executed, this returns the Task ID and a path to the local +session folder. In order to upload to the ClearML Server the local execution data that the Task captured offline, use the +[Task.import_offline_session](references/sdk/task.md#taskimport_offline_session) method. See [Storing Task Data Offline](guides/set_offline.md). + + + ## Graphs and Logs **The first log lines are missing from the experiment console tab. Where did they go?**