diff --git a/docs/guides/ide/integration_pycharm.md b/docs/guides/ide/integration_pycharm.md index 3a5132da..f2163cee 100644 --- a/docs/guides/ide/integration_pycharm.md +++ b/docs/guides/ide/integration_pycharm.md @@ -4,9 +4,14 @@ title: Integration for PyCharm The **ClearML PyCharm plugin** enables syncing a local execution configuration to a remote executor machine: -* Sync local repository information to a remote debug machine. +* Sync local repository information to a remote machine - When using PyCharm to run/debug code remotely using +an SSH connection, PyCharm copies the code base into the remote machine and runs it there. PyCharm does not copy +the `.git` folder into the remote machine, so ClearML can't detect the correct git repository details when running on the +remote machine. The ClearML PyCharm plugin detects the git details on the local +machine, and passes that information to the remote machine to be registered to a [task](../../fundamentals/task.md). -* Multiple users can use the same resource for execution without compromising private credentials. +* Pass user credentials to a remote machine - Multiple users can use the same resource for execution without compromising +private credentials (assuming the entire code base, including `.git` already exists on the remote machine) * Run the [ClearML Agent](../../clearml_agent.md) on default VMs/Containers. @@ -16,7 +21,7 @@ The **ClearML PyCharm plugin** enables syncing a local execution configuration t 1. Install the plugin in PyCharm from local disk: -![image](../../img/ide_pycharm_plugin_from_disk.png) +![PyCharm plugin installation](../../img/ide_pycharm_plugin_from_disk.png) ## Optional: ClearML Configuration Parameters @@ -36,4 +41,11 @@ the settings in the ClearML configuration file. 1. Add ClearML user credentials key/secret. -![image](../../img/ide_pycharm_config_params.png) +1. Check box to disable SSL certificate verification (for on-prem `clearml-server` installations). + +1. Check box to disable local git detection. The PyCharm plugin is often used to run git detection on the local machine +since there is no `.git` folder on the remote machine. In the case that the plugin is used just for passing configuration +to a remote SSH machine, there is no need to run the git detection on the local machine. + + +![PyCharm configuration](../../img/ide_pycharm_config_params.png) diff --git a/docs/img/clearml_pycharm_plugin/pycharm_config_params.png b/docs/img/clearml_pycharm_plugin/pycharm_config_params.png deleted file mode 100644 index 5420eddf..00000000 Binary files a/docs/img/clearml_pycharm_plugin/pycharm_config_params.png and /dev/null differ diff --git a/docs/img/clearml_pycharm_plugin/pycharm_plugin_from_disk.png b/docs/img/clearml_pycharm_plugin/pycharm_plugin_from_disk.png deleted file mode 100644 index 51ea93e4..00000000 Binary files a/docs/img/clearml_pycharm_plugin/pycharm_plugin_from_disk.png and /dev/null differ diff --git a/docs/img/ide_pycharm_config_params.png b/docs/img/ide_pycharm_config_params.png index 09aa4f78..f4013c85 100644 Binary files a/docs/img/ide_pycharm_config_params.png and b/docs/img/ide_pycharm_config_params.png differ