Basic Quickstart (CLI)

User Guide (Latest)

Use this documentation to get a basic introduction to NVIDIA AI Workbench. For the full list of quickstarts, see Quickstart Guides.

In this quickstart, you use the command line interface (CLI) to perform the following tasks:

  1. Start AI Workbench and open a location

  2. Create a new project

  3. Use JupyterLab to write simple code

  4. (Optional) Publish your project to a Git server

Before you can complete the steps in this quickstart, you need the following:

  • NVIDIA AI Workbench is installed on your local system. For more information, see Install AI Workbench.

  1. Open a command shell by doing one of the following:

    • On macOS or Ubuntu — Open your favorite command shell, such as terminal.

    • On Windows — Open the WSL app by searching for WSL in your app list. When the WSL app opens, you should see a command prompt similar to the following:

      Copy
      Copied!
                  

      workbench@computer-name:~$

      Tip

      You can also use Terminal, Command Prompt, or Windows PowerShell, and access WSL by using the command wsl -d NVIDIA-Workbench.

  2. Check the available Locations (Contexts) on your computer by running the following command.

    Copy
    Copied!
                

    nvwb list contexts

    If you haven’t added any remote locations yet, the only available Location is the local computer. The output should look similar to the following.

    Copy
    Copied!
                

    NAME | DESCRIPTION | HOSTNAME | STATUS --------|-------------|-----------|--------------- local | My Computer | localhost | Not Running

  3. Run the following command to start the local Location.

    Copy
    Copied!
                

    nvwb activate local

    AI Workbench starts and connects to your computer, and (nvwb:local) now appears at the beginning of your command prompt.

  1. Start the process to create a project by running the following command.

    Copy
    Copied!
                

    nvwb create project

  2. Enter the project name, description, and press enter to choose the Python Basic container as the base environment for your project. You should see prompts similar to the following.

    Copy
    Copied!
                

    ? Enter a unique name for the project: test-cli-proj ? Enter a description: A hello world test project ? Choose a base environment: Python Basic Created new project 'test-cli-proj' (/home/nvidia/nvidia-workbench/test-project) ✓ Container build complete (59.172564951s)

  3. After you see Container build complete, use the following command to open the project.

    Copy
    Copied!
                

    nvwb open test-cli-proj

    AI Workbench opens your project, changes to the project directory, and (nvwb:local/test-cli-proj) now appears at the beginning of your command prompt.

  1. To open JupyterLab, run the following command.

    JupyterLab opens in your default browser ready for you to start working.

    Copy
    Copied!
                

    nvwb start jupyterlab

  2. In JupyterLab, do the following.

    1. Navigate to the code folder.

    2. Create a new notebook by choosing Python 3 (ipykernel).

    3. In the new notebook, enter print("Hello World!").

    4. Click run to verify the code works correctly.

    5. Save the notebook, and name the file hello-world.ipynb.

    quickstart-6.png


  3. In JupyterLab, choose File, and then click Shut Down. Confirm shut down and close the browser tab.

  4. In your command shell, run the following command to stop your environment.

    Copy
    Copied!
                

    nvwb stop --container

Each AI Workbench project is stored as a Git repository. When you are ready to save changes to your project, you commit and push the changes to your Git repository. For more information, see Connect to Git.

  1. Check for changes to your project by running the following command.

    Copy
    Copied!
                

    nvwb status

    You should see output similar to the following. In this case, there is one new file, the notebook that you added.

    Copy
    Copied!
                

    Name: test-cli-proj (/home/workbench/nvidia-workbench/test-cli-proj) Description: A hello world test project Environment: No Build Required Container: Stopped Applications: jupyterlab: Stopped Local Repository: 1 Added

  2. To create a commit that contains your changes, run the following command.

    Copy
    Copied!
                

    nvwb commit

    AI Workbench creates the commit message for you.

  3. Press enter to accept the commit message and commit your changes.

  4. To publish your changes to a Git server, run the following command. You are prompted for the information to publish your changes.

    Copy
    Copied!
                

    nvwb publish

  5. Open https://github.com/<user_name>/test-cli-proj and verify that you see your project.

Previous Basic Quickstart
Next Customize Your Environment Quickstart
© Copyright © 2024, NVIDIA Corporation. Last updated on Jun 10, 2024.