Configuring Integrations in the Desktop Application

Creating and connecting integrations on the Desktop can be done as part of the initial installation process. However, you may have skipped configuring integrations in the installation or have additional integrations to add. In this case, you may add and configure integrations in the desktop application.

Note

Configuring Integrations in the Desktop Application is currently in Beta testing and will involve opening a separate window. This feature will be integrated into the main Desktop app in the full GA release.

Full support for configuring and adding integrations to NVIDIA AI Workbench is currently only supported in the CLI. Please see here for details.

Accessing the Settings Page

Configuring Integrations in the Desktop Application is currently in Beta testing and is not part of the main AI Workbench application. To access this separate settings window,

  1. Locate the NVIDIA AI Workbench Icon on your desktop toolbar. For example, on Windows it should be located on the bottom right. You may need to expand the dropdown.

  2. Right click on the NVIDIA AI Workbench Icon.

  3. Select Settings. This should open the Workbench Settings window.

    desk-integration-1.png


Expected Output:

What could go wrong:

NA

Connecting an Existing Integration

To connect to an existing integration. Locate the integration on the settings page and select Connect. Fill in the details requested, eg. API key, PAT, etc. and select Submit. Alternatively, you may complete the OAuth authentication.

desk-integration-3.png


Expected Output:

What could go wrong:
  • AI Workbench may show you already connected to the integration of interest. In that case, disconnect, and reconnect.

Disconnecting an Existing Integration

To disconnect from an existing integration. Locate the connected integration on the settings page and select Disconnect. Select Disconnect again on the confirmation screen.

desk-integration-4.png


Expected Output:

What could go wrong:

NA

Adding an New Integration

To add a new integration to AI Workbench, select Add Integration on the top right of the screen. Then fill in Integration Type from the dropdown, Display Name of that integration on AI Workbench, and select an Authentication Method from the dropdown. Then select Add.

desk-integration-7.png


Expected Output:

What could go wrong:
  • Your integration may be unsupported at this time. AI Workbench currently only supports a self-hosted GitLab as a non-default option.

  • Ensure your authentication method is correct and proper authentication credentials are used.

Configuring the Git Author

To adjust the Git Author details, select the Git Author tab from the left menu. Adjust the Name and Email fields, then select Save.

desk-integration-5.png


Expected Output:

What could go wrong:

NA

NGC Account and API Key

  1. Login to your NGC account.

  2. Select the dropdown menu on the top-right, then select Setup.

  3. Under “Generate API Key”, select Get API Key.

  4. Select Generate API Key. Follow any instructions and keep the generated API key in a safe location.

Note

Generating a new NGC API Key may invalidate previous keys.

GitHub Personal Access Token

  1. Login to your GitHub account.

  2. Select the profile picture on the top-right, then select Settings.

  3. Select Developer Settings on the bottom of the left taskbar.

  4. Select Personal access tokens, then select Tokens (classic).

  5. Select Generate New Token and Generate new token (classic). Fill in the permissions and click Generate token Keep the generated PAT in a safe location.

GitLab Personal Access Token

  1. Login to your GitLab account.

  2. Select the profile picture on top of the left taskbar, then select Edit Profile.

  3. Select Access Tokens on the left taskbar.

  4. Select Add new token under “Personal Access Tokens”.

  5. Fill in the details and click Create personal access token Keep the generated PAT in a safe location.

Previous Managing Locations in the Desktop Application
Next Developing Projects in the Desktop Application
© Copyright 2023-2024, NVIDIA. Last updated on Jan 21, 2024.