Quick Start

Prerequisites

To begin using Paperspace, follow these preliminary steps:

  1. Add a valid credit card to enable Paperspace's features

  2. Create a team if higher tiers of service and collaboration features are desired

Now you can create Notebooks, Jobs, Projects, Experiments, and more!

Create a Notebook

Notebooks can be created by clicking Create Notebook button on the Notebooks tab. You can stop, start, fork, and swap out the instance type anytime. Choose from a wide selection of pre-configured templates or bring your own. See more info here.

Submit an Experiment

You can run Experiments from the web interface or CLI:

Using the Experiment Builder

Using the CLI

Before creating an experiment using the CLI, you must first create a Project for your Experiments to live in. To create a Project, navigate to Gradient > Projects in the UI and click Create Project. Then select Create Standalone Project and provide a project name. Now, you can use the created Project's Project ID in order to create Experiments in that Project via the CLI.

Example command

The following command will work and will create and start an Experiment that will display properties of the attached GPU. Be sure to replace <your-project-id> with your Project ID.

Note: Currently, we recommend adding your API Key as an option.

gradient experiments run singlenode --projectId <your-project-id> --container 'Test-Container' --machineType P4000 --command 'nvidia-smi' --name 'test-01' --workspaceUrl none --apiKey <your-api-key>

Your commands will look similar. Note that you can also create multi-nodeExperiments, and you can use the create command to simply create Experiments that can be started later.

These Experiments will be uploaded to our cluster of machines. Behind the scenes, Paperspace is creating a Docker container and running the command you provided. There are several optional Experiment parameters, such as to specify your workspace (the additional files to be used in your experiment). You can always use the --help option after any command in the CLI for more info.

Monitor your Experiment progress

Experiments states transition from Queued > Pending > Running. **Once the Experiment is in the Running state, you can watch your Experiment run in the CLI and web UI. An Experiment can complete with the following states: Success, Cancelled, Error, or Failed**.

Congratulations! You ran your first Experiment on Gradientº 🚀

Experiments have a ton of functionality that this quick example doesn't cover. To learn more, view the Experiments section.