Add offline logging Example (#12)

docs/guides/set_offline.md

@@ -0,0 +1,55 @@
+---
+title: Storing Task Data Offline
+---
+
+If your computer is offline, or you do not want a Task's data and logs stored in the ClearML Server, use
+the **Offline Mode** option. In this mode, all the data and logs that the Task captures from the code are stored in a 
+local folder, which can be later uploaded to the [ClearML Server](../deploying_clearml/clearml_server.md).
+
+## Setting Task to offline mode
+
+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`.
+
+```python
+from clearml import Task
+# Use the set_offline class method before initializing a Task
+Task.set_offline(offline_mode=True)
+# Initialize a Task 
+task = Task.init(project_name="examples", task_name="my_task")
+
+# Rest of code is executed. All data is logged locally and not onto the server
+```
+
+The method returns the Task ID and a path to the local session folder:
+
+```console
+ClearML Task: created new task id=offline-372657bb04444c25a31bc6af86552cc9
+...
+...
+ClearML Task: Offline session stored in /home/user/.clearml/cache/offline/b786845decb14eecadf2be24affc7418.zip
+```
+
+## Uploading local session
+
+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. This method will upload the 
+Task's full execution details and outputs. 
+
+```python
+from clearml import Task
+
+Task.import_offline_session(session_folder_zip="path/to/session/.clearml/cache/offline/b786845decb14eecadf2be24affc7418.zip")
+```
+
+In the `session_folder_zip` argument, insert the path to the zip folder containing the session.
+
+This method returns a link to the Task's results page on the ClearML Server:
+
+```console
+ClearML: Importing offline session from /home/user/.clearml/cache/offline/b786845decb14eecadf2be24affc7418.zip
+ClearML results page: https://app.community.clear.ml/projects/4043a1657f374e9298649c6ba72ad233/experiments/bb8b0f6fa0f94536a0d27fb55f02d3a5/output/log
+```
+
+The session details can be viewed in the ClearML WebApp, in the "my_task" experiment of the "examples" 
+project, as specified when initializing the Task.

sidebars.js

@@ -92,6 +92,7 @@ module.exports = {
                 {'XGboost': ['guides/frameworks/xgboost/xgboost_sample']}
             ]},
             {'IDEs': ['guides/ide/remote_jupyter_tutorial', 'guides/ide/integration_pycharm', 'guides/ide/google_colab']},
+            {'Offline Mode':['guides/set_offline']},
             {'Optimization': ['guides/optimization/hyper-parameter-optimization/examples_hyperparam_opt']},
             {'Pipelines': ['guides/pipeline/pipeline_controller']},