Developing Projects in the Desktop Application

Seeing Available Projects in Location

To see available Projects you must first be in an active Location window. To activate a Location, select it from the My Locations window.

activate-context-11.png

Example Output:

This will redirect to a new window that lists Projects available in that Location.

activate-context-21.png

What can go wrong:

  • If the Location is not available, e.g. the system is not on, opening the window will give an error.

Creating a Project

To start a new Project in a Location window, select New Project in the top right-hand corner.

create-project-1.png

Fill in the Project Name and Description fields. The Local Path will automatically populate to the default location but can be changed with user input. Select Next.

create-project-2.png


Select the Base Image to use for this new project environment. Then select Create.

create-project-3.png


Example Output:

You will be redirected to the Project page and the Project will build. You can monitor the status on the bottom right-hand corner under Build In Progress.

create-project-4.png


What can go wrong:

  • The Base Images can be large, on the order of tens of Gigabytes. Depending on your network the build can appear to hang.

Opening a Project

To open an existing Project, select it from the My Projects tab of Location window.

open-project-1.png

Example Output:

This will open a tab to that project’s page.

open-project-2.png

What can go wrong:

  • NA

Closing a Project

To close an open Project in a Location, press the “X” on the Project tab near the top of the window and confirm the selection.

What can go wrong:

  • You cannot close a tab with a running container. If a container is running, AI Workbench will prompt you to stop it.

Checking the Status of a Project

To check the status of a project while using the Desktop App, open the intended project.

Example Output:

project-status-1.png

View the commit, sync, branch, build status, and application status of the project on the top and bottom of the page.

  • Click on Commit in the top bar to see the changes eligible to be committed and the message.

  • Click on any of the options in the Status Widget at the bottom.

What can go wrong:

  • NA

Versioning a Project

Select the Commit button on the top of the window. Review and edit the commit information. Then select Commit to commit the changes and create a new version.

sync-project-2.png

Example Output:

sync-project-3.png

What can go wrong:

  • You are trying to commit files to a folder that has git storage but they are too large. NVIDIA AI Workbench is prompting you to move them to a folder with gitlfs or .gitignore storage.

Publishing a Project to a Git Server

Select the Publish button on the top of the window. Review and edit the information to specify the Git Remote Server, Namespace, and Repository Visibility. Select Publish to confirm.

sync-project-4.png

Example Output:

sync-project-5.png

What can go wrong:

  • You have not yet configured an integration for a Git server.

  • Your access to the Git server has changed, e.g. your credentials are outdated.

Cloning a Project

Select Clone Project on the top right-hand corner of the Location window. Fill in the Remote URL field with your intended project repository URL. The Local Path will automatically populate to the default location but can be changed with user input. Select Clone to begin the cloning process.

clone-project-1.png

Example Output:

clone-project-2.png

What can go wrong:

  • You may not have authorized access to the repository you are trying to clone.

  • You may not have access to the Base Image the Project uses.

  • The Base Image can be large. Depending on your network the build can appear to hang.

Deleting a Project

On the Project page, select the Settings tab on the left-hand menu. Then, select Delete, and confirm your selection. Your project will be deleted.

delete-project-1.png

Example Output:

delete-project-2.png

What can go wrong:

  • You cannot delete a project that is currently building. Stop the build or wait for it to finish before deleting the project.

Adding Environment Variables

Go to the Environment tab on the left-hand side of the project page. Scroll down to the Environment Variables section and select Add. Specify the environment variable Name and Value and select Add. If already running, restart your project for the changes to take effect in your environment.

env-var-1.png

Example Output:

env-var-2.png

env-var-3.png

What can go wrong:

  • NA

Adding Secrets

Project secrets are special environment variables to handle sensitive information, such as login credentials and API Keys. Go to the Environment tab on the left-hand side of the project page. Scroll down to the Secrets section and select Add. Specify the secret Name, Value, and Description and select Add. If already running, restart your project for the changes to take effect in your environment.

env-var-11.png

Example Output:

secrets-2.png

secrets-3.png

What can go wrong:

  • NA

Configuring Mounts

Go to the Environment tab on the left-hand side of the project page, scroll down to the Mounts section and select Add, specify the mount Type, Target Directory, Source Directory, and/or Description. Then, select Add. Rebuild your project for the changes to take effect in your environment.

env-var-11.png

Example Output:

mounts-2.png

mounts-3.png

What can go wrong:

  • NA

Previous Configuring Integrations in the Desktop Application
Next Running Applications in the Desktop Application
© Copyright 2023-2024, NVIDIA. Last updated on Jan 21, 2024.