Share AI Workbench Projects with Deep Links#
You can share NVIDIA AI Workbench projects with deep links that you create in the AI Workbench Desktop App. You can add the deep link as a badge to your README that directs visitors directly to your project in AI Workbench.
Use this documentation to learn about the following:
Open an AI Workbench Project from a Deep Link#
You can open an AI Workbench project that someone shares with you as a deep link by clicking the link or pasting the link URL in a browser address bar. AI Workbench lets you select the AI Workbench location you want to use the project in, and then automates cloning and opening the project for you.
When you click a link to open an existing project, you are prompted to open the project, and there is a link to install AI Workbench if necessary.
After you open the project, AI Workbench starts building the project. You can track the build progress in the status bar of the AI Workbench window. For more information, see Basic Quickstart.
Example
The following example deep link clones the NVIDIA Hybrid RAG project from GitHub, and opens it in AI Workbench:
Create a Deep Link to Share Your AI Workbench Project#
You can create a deep link to any AI Workbench project that you have published to GitHub or GitLab with the following procedure.
Open your project in AI Workbench.
Click Settings on the left.
In the Share Project section, the URL to share your project appears.
1<hash>
Copy the URL and share it as needed. For public projects, anyone with the URL can access it, as the permissions of the Git repository/server are still enforced. Note that the project must be published to a Git repository to use share URLs. For private projects, only users with the appropriate access permissions can successfully clone the repository. For public projects, anyone can clone it.
Get a Deep Link Badge for Your Repo to Share Your AI Workbench Project#
You can get a badge for your web page that links users to your AI Workbench project. The badge looks like the following:
Use the following procedure to get your badge:
Open your project in AI Workbench.
Click Settings on the left.
In the Share Project section, open the Badge tab.
The code to create the badge appears. The code is in Markdown and looks like the following.
1[](<Your-URL>)
Copy the Markdown code for the badge to your clipboard.
Paste the code on any Markdown page.