project

project

Source:

Methods

(static) clear(cb) → {object}

Source:

Clear the project configuration settings. Only the project name will remain in the config file.

Examples
paperspace.project.clear(function(err, res) {
  // handle error or result
});
$ paperspace project clear
# Note: there is no HTTP request corresponding to 'paperspace project clear'.
// Example return value:
{
  "project": "myproject",
}
Parameters:
Name Type Description
cb function

Node-style error-first callback function
Returns:

project config

Type
object

(static) init(cb) → {object}

Source:

Create a new Paperspace project. A project is simply a directory or name for a set of related files and jobs. If you do not init a particular name or directory job commands will be given a project name corresponding to the current directory name. 'paperspace project init' creates a .ps_project/config.json file in the current directory to cache information about the project, such as the name, or the last job created.

Examples
paperspace.project.init({
  name: 'myproject',
}, function(err, res) {
  // handle error or result
});
$ paperspace project init
# Note: there is no HTTP request corresponding to 'paperspace project init'.
// Example return value:
{
  "project": "myproject",
}
Parameters:
Name Type Attributes Description
params.project string <optional>

The name of the project. If provided, this stored in the .ps_project/config.json file of the directory name.
cb function

Node-style error-first callback function
Returns:

project

Type
object

(static) show(cb) → {object}

Source:

Show the project configuration settings.

Examples
paperspace.project.show(function(err, res) {
  // handle error or result
});
$ paperspace project show
# Note: there is no HTTP request corresponding to 'paperspace project show'.
// Example return value:
{
  "project": "myproject",
  "lastJobId": "j123abc",
}
Parameters:
Name Type Description
cb function

Node-style error-first callback function
Returns:

project config

Type
object