Gradient Docs
Gradient HomeHelp DeskCommunitySign up free
Gradient Next
Gradient Next
  • About Gradient
  • Get Started
    • Quick Start
      • Install the Gradient CLI
    • Core Concepts
    • Organizing Projects
      • Secrets
      • Storing an API key as a Secret
    • Tutorials
      • Gradient Notebooks Tutorial
      • Gradient Workflows Tutorial
      • Gradient Deployments Tutorial
    • FAQ
    • Common Errors
  • Gradient Platform
    • Gradient Notebooks
      • Runtimes
      • Files and storage
      • Machines
      • Terminal
      • Shortcuts
      • Sharing
      • TensorBoard
      • Run on Gradient
    • Gradient Workflows
      • Basic operations
      • Understanding Inputs & Outputs
      • Workflow Spec
      • Gradient Actions
      • Environment Variables
      • Using YAML for Data Science
    • Gradient Deployments
      • Basic operations
      • Deployment Spec
  • Artifacts
    • Container Management
      • Custom Containers
    • Data
      • Versioned Data
        • Public Datasets Repository
        • Storage Providers
      • Persistent Storage
    • Models
      • Managing Models
        • Model Types & Metadata
        • Public Models
    • Code
    • Metrics
      • Push Metrics
      • View & Query Metrics
  • Gradient Cluster
    • Overview
      • Setup
        • Managed Private Clusters
        • Self-Hosted Clusters
          • Pre-installation steps
          • Gradient Installer CLI
          • Terraform
            • Pre-installation steps
            • Install on AWS
            • Install on bare metal / VMs
            • Install on NVIDIA DGX
          • Let's Encrypt DNS Providers
          • Updating your cluster
      • Usage
  • More
    • SDK
      • Projects Client
      • Models Client
      • Deployments Client
      • Workflows Client
      • SDK Examples
      • Full SDK Reference
    • Machine Types
      • Machine Tiers
      • Free Machines (Free Tier)
    • Your Account
      • Teams
        • Creating a Team
        • Upgrading to a Team Plan
      • Hotkeys
      • Billing & Subscriptions
        • Storage Billing
      • Public Profiles
    • Release notes
    • Roadmap
Powered by GitBook
On this page
  • Introduction to sharing and forking notebooks
  • How to share a notebook
  • How to fork a notebook
  • How to configure a notebook for forking
  • Reference for operations within .notebookinclude file
  1. Gradient Platform
  2. Gradient Notebooks

Sharing

This guide explains how to share and/or fork Gradient Notebooks

PreviousShortcutsNextTensorBoard

Last updated 3 years ago

Introduction to sharing and forking notebooks

Gradient Notebooks makes it easy to collaborate with teammates. Notebooks are shared at the team level and can take advantage of at the team level. Notebooks can also be made public or private.

How to share a notebook

The Share button in the notebook IDE provides a quick and easy way to generate a shareable link for a notebook.

If public access is granted, anyone with the link will be able to view the contents of the notebook.

How to fork a notebook

Forking is useful to clone a public notebook into our workspace or to duplicate a notebook that is already in our workspace. Forking a notebook creates a new history for the notebook.

Fork a notebook from within the notebook IDE by using the hamburger menu in the top left of the IDE:

Fork a notebook from the Gradient Notebooks console using the 3-dot menu:

How to configure a notebook for forking

The default .notebookinclude file looks like this:

*.md
*.ipynb

# and all of the files from `git ls-files`

In the following example, we tell gradient to upload all .png files to the storage provider while skipping dataset files:

*.png # include all png files
!datasets/**/*.png # exclude the ones in my datasets

Now we will use a negative example to exclude .md files:

!*.md

Reference for operations within .notebookinclude file

Item
Description

#

Comments out the line

!

Negates the pattern

/

Directory separator

\*

Wildcard

?

Wildcard exactly one character

[a-zA-Z]

Range notation to match a character in the range

**/

Match in all directories

/**

Match all files within a directory

a\*\*/b

Match zero or more directories between a and b

The files copied to the notebook are those listed in the , which is explained in the next section.

When a notebook is offline, some files are copied to the to enable offline viewing. By default, the list of files includes .ipynb and .md files. Additionally, if the notebook was instantiated using a git repo as a workspace, Gradient will upload any files that are tracked by git.

It's possible to specify exactly which files should be available offline by providing a .notebookinclude file in the /notebooks .

The file is similar to syntax found in a file, however in this case we will be including files instead of ignoring them. Negative patterns are supported.

notebook include file
storage provider
directory
.gitignore
shared persistent storage
Use the Share button in the notebook IDE to generate a unique link for a notebook.
Notebooks can be forked using the menu within the notebook IDE.
Notebooks may also be forked using the menu in the Gradient Notebooks console.