Skip to content
This repository was archived by the owner on Jun 6, 2023. It is now read-only.

Commit 55950d5

Browse files
committed
doc updates
1 parent b7b5992 commit 55950d5

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

lib/jobs/clone.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var assign = require('lodash.assign');
3939
* "project": "myproject",
4040
* "container": "http://dockerhub.com/mycontainer",
4141
* "machineType": "P5000",
42-
* "cluster": "Jobs",
42+
* "cluster": "PS Jobs",
4343
* "usageRate": "P5000 hourly",
4444
* "startedByUserId": "u789ghi",
4545
* "parentJobId": "j123abc",

lib/jobs/create.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ var jobs_show = require('./../jobs/show.js');
2020
* @description Create a new Paperspace job, and tail its log output if run at the command line. To disable the tailing behavior specify '--tail false'. Note: if a project is not defined for the current working directory, and you are running in command line mode, a project configuration settings file will be created. Use '--init false' or specify '--project [projectname]' to override this behavior.
2121
* @param {object} params - Job creation parameters
2222
* @param {string} params.container - A required reference to a container name or container link to be used for the job.
23-
* @param {string} [params.machineType] - An optional machine type to run the job on: either 'GPU+', 'P4000', 'P5000', 'P6000', 'V100', 'C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9', or 'C10'.<p>Defaults to 'P5000'.
23+
* @param {string} [params.machineType] - An optional machine type to run the job on: either 'GPU+', 'P4000', 'P5000', 'P6000', 'V100', 'K80', or 'P100'.<p>Defaults to 'K80'. <P>Note: the 'K80' and 'P100' machineTypes run on Google Cloud Platform (GCP). The other machineTypes run on the Paperspace Cloud. Google Cloud platform and Paperspace Cloud have distict Job Storage spaces; Job storage is not currently shared between these two cloud environments.
2424
* @param {string} [params.name] - An optional name or description for this job. If ommitted, the job name defaults to 'job for project [projectname]'.
2525
* @param {string} [params.project] - The name of the project for this job. If not provided, this is taken from the .ps_project/config.json file, or the current directory name.
2626
* @param {string} [params.projectId] - The poject id of an existing project for this job. Note: if projectId is specified, the project parameter cannot be specified.
@@ -38,7 +38,7 @@ var jobs_show = require('./../jobs/show.js');
3838
* @example
3939
* paperspace.jobs.create({
4040
* container: 'http://dockerhub.com/mycontainer',
41-
* machineType: 'P6000',
41+
* machineType: 'P5000',
4242
* }, function(err, res) {
4343
* // handle error or result
4444
* });
@@ -66,7 +66,7 @@ var jobs_show = require('./../jobs/show.js');
6666
* "project": "myproject",
6767
* "container": "http://dockerhub.com/mycontainer",
6868
* "machineType": "P5000",
69-
* "cluster": "Jobs",
69+
* "cluster": "PS Jobs",
7070
* "usageRate": "P5000 hourly",
7171
* "startedByUserId": "u789ghi",
7272
* "parentJobId": null,

lib/jobs/list.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var path = require('path');
2626
* @example
2727
* paperspace.jobs.list(
2828
* project: 'MyProject'
29-
* } function(err, res) {
29+
* }, function(err, res) {
3030
* // handle error or result
3131
* });
3232
* @example
@@ -55,7 +55,7 @@ var path = require('path');
5555
* "project": "myproject",
5656
* "container": "http://dockerhub.com/mycontainer",
5757
* "machineType": "P5000",
58-
* "cluster": "Jobs",
58+
* "cluster": "PS Jobs",
5959
* "usageRate": "P5000 hourly",
6060
* "startedByUserId": "u789ghi",
6161
* "parentJobId": null,

lib/jobs/show.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ var assign = require('lodash.assign');
4141
* "project": "myproject",
4242
* "container": "http://dockerhub.com/mycontainer",
4343
* "machineType": "P5000",
44-
* "cluster": "Jobs",
44+
* "cluster": "PS Jobs",
4545
* "usageRate": "P5000 hourly",
4646
* "startedByUserId": "u789ghi",
4747
* "parentJobId": null,

lib/jobs/waitfor.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ var assign = require('lodash.assign');
5252
* "project": "myproject",
5353
* "container": "http://dockerhub.com/mycontainer",
5454
* "machineType": "P5000",
55-
* "cluster": "Jobs",
55+
* "cluster": "PS Jobs",
5656
* "usageRate": "P5000 hourly",
5757
* "startedByUserId": "u789ghi",
5858
* "parentJobId": null,

0 commit comments

Comments
 (0)