2021-05-13 23:48:51 +00:00
|
|
|
---
|
|
|
|
|
title: Integration for PyCharm
|
|
|
|
|
---
|
|
|
|
|
|
2021-06-20 22:00:16 +00:00
|
|
|
The **ClearML PyCharm plugin** enables syncing a local execution configuration to a remote executor machine:
|
2021-05-13 23:48:51 +00:00
|
|
|
|
|
|
|
|
* Sync local repository information to a remote debug machine.
|
|
|
|
|
|
|
|
|
|
* Multiple users can use the same resource for execution without compromising private credentials.
|
|
|
|
|
|
2021-06-20 22:00:16 +00:00
|
|
|
* Run the [ClearML Agent](../../clearml_agent.md) on default VMs/Containers.
|
2021-05-13 23:48:51 +00:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2021-05-18 22:31:01 +00:00
|
|
|
1. Download the latest plugin version from the [Releases page](https://github.com/allegroai/clearml-pycharm-plugin/releases).
|
2021-05-13 23:48:51 +00:00
|
|
|
|
|
|
|
|
1. Install the plugin in PyCharm from local disk:
|
|
|
|
|
|
2021-06-20 22:00:16 +00:00
|
|
|
|
2021-05-13 23:48:51 +00:00
|
|
|
|
2021-09-09 10:17:46 +00:00
|
|
|
## Optional: ClearML Configuration Parameters
|
2021-05-13 23:48:51 +00:00
|
|
|
|
|
|
|
|
:::warning
|
|
|
|
|
If you set ClearML configuration parameters (ClearML Server and ClearML credentials) in the plugin, they will override
|
|
|
|
|
the settings in the ClearML configuration file.
|
|
|
|
|
:::
|
|
|
|
|
|
|
|
|
|
**To set ClearML configuration parameters:**
|
|
|
|
|
|
2021-06-20 22:00:16 +00:00
|
|
|
1. In PyCharm, open **Settings** **>** **Tools** **>** **ClearML**.
|
2021-05-13 23:48:51 +00:00
|
|
|
|
2021-06-20 22:00:16 +00:00
|
|
|
1. Configure your ClearML server information:
|
2021-05-13 23:48:51 +00:00
|
|
|
1. API server (for example: ``http://localhost:8008``)
|
|
|
|
|
1. Web server (for example: ``http://localhost:8080``)
|
|
|
|
|
1. File server (for example: ``http://localhost:8081``)
|
|
|
|
|
|
|
|
|
|
1. Add **ClearML** user credentials key/secret.
|
|
|
|
|
|
2021-06-20 22:00:16 +00:00
|
|
|
|
