Use Remote Python Interpreter in PyCharm with cnvrg

In this tutorial, we will take you through the steps required to connect PyCharm on your local machine to a remote cnvrg workspace.

Requirements

You must have the following installed on your local machine:

• cnvrg CLI installed
• kubectl
• The enterprise version of PyCharm

Guide

1. Go to your project's Workspaces tab and launch any workspace type inside cnvrg. Wait for the setup to complete.
2. On your local machine, run the command cnvrg ssh start workspace_id in a terminal session.

TIP

The workspace_id can be found in the URL for the workspace.

For example, if your workspace is live at https://app.cnvrg.io/acme/projects/recommender/notebook_sessions/show/ekqjsnzerv9x5t62y7yd, then the workspace_id would be ekqjsnzerv9x5t62y7yd.

1. Wait for ssh to start. During this time, cnvrg will automatically install the requirements in the workspace. When it has started, the command will tell you the host, port, username and password for the SSH session.

1. In your local PyCharm, open Settings/Preferences.
2. Search for project and select Project Interpreter in the left menu.

3. Next to Project Interpreter menu, click the gear icon and select Add from the menu.

4. In the Add Python Interpreter pop-up, click SSH Interpreter in the left menu.

5. Enter the SSH details based on what cnvrg ssh start has told you. Then, click Next.

6. Enter the password from the cnvrg ssh start command. Then, click Next.

7. In the following screen, check the Python interpreter path is correct per your image (usually this does not need to be changed). Then, click the folder button next to Sync Folders.
8. In the pop-up, ensure the project folder's Local Path has /cnvrg set as the Remote Path. Then, click Okay.

9. Click Finish.
10. With PyCharm open regularly, open the Interpreter settings (next to the play button).
11. On the popup, set the Working directory as /cnvrg.

12. Congratulations, you will now have connected to the remote workspace! When you have this remote interpreter selected (it should be the default now), the code will be run inside the remote workspace. Enjoy using all the PyCharm features you know and love, backed by the power of a remote cnvrg workspace.