Using Machines

Create a Machine

Web UI
CLI
Web UI

The steps below describe how to Create a new Machine via the UI.

Navigate to the Machines page and click "New Machine +" at the top-right:

This will take you to the Machine Create page.

There, select the Region where you want your Machine to reside:

Choose the OS for your Machine:

Toggle whether you want your Machine to bill hourly or monthly, and select your Machine type depending on your desired CPU or GPU:

Select the amount of Storage you want:

You can then specify how many of these Machines you want to create, and type in a name for each of them by clicking the input field that says New Machine 1 below, for example.

Note that you can also click "Assign Machine" to assign that machine to a particular user on your team, if you are on a team:

Then choose a Network if desired:

Toggle whether you want Auto-Shutdown, Auto Snapshot, and Public IP.

If Auto-Snapshot is enabled, then select the period of time after which auto-shutdown should occur. This is useful, for example, in order to avoid being billed for machine time that you aren't using your Machine but may have forgotten to turn it off.

If Auto Snapshot is enabled, then select the frequency at which you want a snapshot of your Machine to be created and persisted. This is useful in order to ensure that you have a regular backup of your Machine.

If Public IP is enabled, your Machine will be assigned a single static address. This is useful, for example, if you are using your Machine as a persistent server or for a web app.

Finally, click Create Your Paperspace to create your Machine. You will see the amount you'll initially be billed (for Storage) as well as the ongoing hourly or monthly cost for the Machine. You can also apply any Promo Code and verify your credit card information before doing so.

Et voilà! Your Machine will spin up in the background, and you'll see it appear back on the Machines list page.

CLI

Usage:

gradient machines create [OPTIONS]

Create a new Paperspace virtual machine. If you are using an individual account, you will be assigned as the owner of the machine. If you are a team administrator, you must specify the user that should be assigned to the machine, either by specifying a user id, or by providing an email address, password, first name and last name for the creation of a new user on the team.

Parameters:

Name

Description

region [CA1|NY2|AMS1]

Name of the region (required)

machineType [Air|Standard|Pro|Advanced|GPU+|P4000|P5000|

P6000|V100|C1|C2|C3|C4|C5|C6|C7|C8|C9|C10]

Machine type (required), pick one

size (INTEGER)

Storage size for the machine in GB (required)

billingType [monthly|hourly]

Either monthly or hourly billing (required)

machineName

A name for this machine (required)

templateId

Template id of the template to use for creating this machine (required)

assignPublicIp

Assign a new public ip address on machine creation. Cannot be used with dynamicPublicIp

dynamicPublicIp

Assigns a new public ip address on machine start and releases it from the account on machine stop. Cannot be used with assignPublicIp

networkId (TEXT)

If creating on a specific network, specify its id

teamId (TEXT)

If creating the machine for a team, specify the team id

userId (TEXT)

If assigning to an existing user other than yourself, specify the user id (mutually exclusive with email, password, firstName, lastName)

email (TEXT)

If creating a new user for this machine, specify their email address (mutually exclusive with userId)

password (TEXT)

If creating a new user, specify their password (mutually exclusive with userId)

firstName (TEXT)

If creating a new user, specify their first name (mutually exclusive with userId)

lastName (TEXT)

If creating a new user, specify their last name (mutually exclusive with userId)

notificationEmail (TEXT)

Send a notification to this email address when complete

scriptId (TEXT)

The script id of a script to be run on startup. See the Script Guide for more info on using scripts