User Interface

This is a high-level conceptual overview of the Workbench User Interface (UI). To quickly get started with working on the UI, see the corresponding Quickstart topic(s) (Desktop and CLI) and for detailed reference information, see the Deep Dive topics.

  • A friendly UI that is installed on your primary, local system, e.g. laptop, that comes as a Desktop App with a graphical user interface or as a Command-line Interface (CLI).

  • Provides a unified experience and view across your local system and remote systems that simplifies versioning, container management, and application handling for Workbench Projects. Example Projects Catalog.

  • Lets you work naturally with IDEs like JupyterLab for interactive development.

Basic Concepts

Location

A system (local or remote) with the appropriate NVIDIA AI Workbench components installed. Provides a predictable, managed user experience independent of the particular system.

Project

An AI Workbench-managed Git repository that comes with a containerized environment. Provides you with predictable portability and reproducibility across Locations.

This is a graphical user interface installed on your primary local system, e.g. a laptop.

The main pattern

  • Start by selecting or adding a Location in the main window, My Locations.

  • A separate window for the Location will open to the home tab, e.g. My Projects | local, and show the Projects on disk in that Location.

  • Selecting a Project in the main My Projects tab will open a tab for the Project in the Location window.

  • Closing the tab will close the Project.

Location conventions

  • You can have multiple Location windows active at the same time. Each location can support multiple users, but one concurrent user at a time.

  • Closing the window will deactivate the Location and kill any active CLI sessions you have in that Location.

Project conventions

  • You can have multiple Projects open in the Location Window.

  • Closing the Project will stop the Project container if it is running.

  • A project can only be open in one window at a time.

Integration conventions

  • Integrations are connected via the CLI or Desktop, and then they are available for use in all Locations and Projects.

  • An integration for a private GitLab server must first be created before it can be connected.

This is an interactive Text-Based User Interface installed on your local system. It has the same features as the Desktop App, plus a few more.

The main pattern nvwb [command1] [command2] [flags], where some commands will provide you with drop-down lists or interactive forms.

Location conventions

  • You activate a Location in a given terminal with the command nvwb activate <location_name>, and that is the only Active Location in that terminal until you deactivate it with nvwb deactivate.

  • When the terminal is in an Active Location, (nvwb: <location_name>) will be prepended to your prompt. This disappears when you deactivate the Location.

  • Being in an Active Location does not mean your prompt is on that system. It just means that all relevant nvwb commands will point at that Location.

  • You can have the same Location active in different terminals.

  • A Location can be active in the terminal and a Desktop App window at the same time. However, deactivating on the CLI with the --shutdown flag will kill the other.

Project conventions

  • In an Active Location, you open a Project on disk in that location with the command nvwb open <project_name>, and that is the only Project open in that terminal until you close it with nvwb close.

  • When the Project is open in the terminal, the Project name is added to your prompt, i.e. (nvwb: <location_name>/<project_name>). This disappears when you close the Project.

  • Being in an Open Project does not mean your prompt is in the Project directory. It just means that all relevant nvwb commands will point at that Project in that Location.

  • You can have the same Project open in different terminals.

Integration conventions

  • Working with Integrations is independent of Project and Location.

  • You connect an integration with the command nvwb connect integration.

  • Once connected, Integrations are available for use in all Locations and Projects.

Previous Applications
Next Bring Your Own Container (BYOC)
© Copyright 2023-2024, NVIDIA. Last updated on Jan 21, 2024.