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

Commit 44c1697

Browse files
sanfilipsanfilip
committed
doc update
1 parent 848a125 commit 44c1697

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+365
-86
lines changed

‎docs/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ <h4>Issues</h4><ul>
116116
<li>List method exact date searches don't find matches</li>
117117
<li>List method null value searches don't find matches</li>
118118
</ul>
119-
<h2>Getting started</h2><p>Your system will need <a href="https://nodejs.org">Node.js</a> v4+ installed. Check that you have a recent enough version by running <code>node -v</code> in your terminal. Node.js comes bundled with <code>npm</code>, the Node.js package management tool, which you'll use to install this package.</p>
119+
<h2>Getting started</h2><p>Your system will need <a href="https://nodejs.org">Node.js</a> v8+ installed. Check that you have a recent enough version by running <code>node -v</code> in your terminal. Node.js comes bundled with <code>npm</code>, the Node.js package management tool, which you'll use to install this package.</p>
120120
<h3>Installation</h3><p>Install the package from npm:</p>
121121
<pre class="prettyprint source"><code>$ npm install -g paperspace-node</code></pre><p>The reason we recommend installing it globally is so the <code>paperspace</code> command will be available on your command line everywhere on your system. If you only want to make it available within an individual Node.js project, you can install it locally by omitting the <code>-g</code> flag.</p>
122122
<h3>Setup</h3><p>Before you can use this tool, you'll need a <a href="https://paperspace.com">Paperspace account</a>. You'll use this account to obtain Paperspace API keys.</p>
@@ -168,7 +168,7 @@ <h2>Copyright</h2><p>Copyright :copyright: 2017 Paperspace - All Rights Reserved
168168
<br class="clear">
169169

170170
<footer>
171-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
171+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
172172
</footer>
173173

174174
<script>prettyPrint();</script>

‎docs/jobs.html‎

Lines changed: 134 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -458,22 +458,25 @@ <h4 class="name" id=".artifactsGet"><span class="type-signature">(static) </span
458458
<h5>Examples</h5>
459459

460460
<pre class="prettyprint"><code>paperspace.jobs.artifactsGet({
461-
jobId: 'j123abc',
462-
files: 'myfiles*' // optional
461+
jobId: 'j123abc'
463462
}, function(err, res) {
464463
// handle error or result
465464
});</code></pre>
466465

467466
<pre class="prettyprint"><code>$ paperspace jobs artifactsGet \
468-
--jobId "j123abc" \
469-
--files "myfiles*"</code></pre>
467+
--jobId "j123abc"</code></pre>
470468

471469
<pre class="prettyprint"><code># HTTP request:
472470
https://api.paperspace.io
473471
GET /jobs/artifactsGet?jobId=j123abc&amp;files=myfiles*
474472
x-api-key: 1ba4f98e7c0...
475473
# Returns 200 on success</code></pre>
476474

475+
<pre class="prettyprint"><code>//Example output:
476+
Downloading myoutput1.txt
477+
Downloading myoutput2.txt
478+
Downloads finished</code></pre>
479+
477480

478481

479482

@@ -803,18 +806,31 @@ <h5>Examples</h5>
803806

804807
<pre class="prettyprint"><code>paperspace.jobs.artifactsList({
805808
jobId: 'j123abc',
809+
size: true
806810
}, function(err, res) {
807811
// handle error or result
808812
});</code></pre>
809813

810814
<pre class="prettyprint"><code>$ paperspace jobs artifactsList \
811-
--jobId "j123abc"</code></pre>
815+
--jobId "j123abc" \
816+
--size true</code></pre>
812817

813818
<pre class="prettyprint"><code># HTTP request:
814819
https://api.paperspace.io
815820
GET /jobs/artifactsList?jobId=j123abc
816821
x-api-key: 1ba4f98e7c0...
817-
# Returns 200 on success</code></pre>
822+
# Returns 200 on success
823+
//Example return value:
824+
[
825+
{
826+
"file": "myoutput1.txt"
827+
"size": 443141
828+
},
829+
{
830+
"file": "myoutput2.txt"
831+
"size": 1456
832+
}
833+
]</code></pre>
818834

819835

820836

@@ -1121,8 +1137,31 @@ <h5>Examples</h5>
11211137
<pre class="prettyprint"><code>//Example return value:
11221138
{
11231139
"id": "j345abc",
1124-
"name": "My Job",
1125-
"state": "running",
1140+
"name": "job for project myproject",
1141+
"state": "Pending",
1142+
"workspaceUrl": "myproject.zip",
1143+
"workingDirectory": "/paperspace",
1144+
"artifactsDirectory": "/artifacts",
1145+
"entrypoint": "echo Hello Paperspace",
1146+
"projectId": "pr456def",
1147+
"project": "myproject",
1148+
"container": "http://dockerhub.com/mycontainer",
1149+
"machineType": "P5000",
1150+
"cluster": "Jobs",
1151+
"usageRate": "P5000 hourly",
1152+
"startedByUserId": "u789ghi",
1153+
"parentJobId": "j123abc",
1154+
"jobError": null,
1155+
"dtCreated": "2017-11-30T19:20:38.956Z",
1156+
"dtModified": "2017-11-30T19:20:39.744Z",
1157+
"dtProvisioningStarted": null,
1158+
"dtProvisioningFinished": null,
1159+
"dtStarted": null,
1160+
"dtFinished": null,
1161+
"dtTeardownStarted": null,
1162+
"dtTeardownFinished": null,
1163+
"dtDeleted": null,
1164+
"exitCode": null
11261165
}</code></pre>
11271166

11281167

@@ -1342,11 +1381,11 @@ <h5>Examples</h5>
13421381

13431382
<pre class="prettyprint"><code>$ paperspace jobs create \
13441383
--container "http://dockerhub.com/mycontainer" \
1345-
--machineType "P6000"</code></pre>
1384+
--machineType "P5000"</code></pre>
13461385

13471386
<pre class="prettyprint"><code># HTTP request:
13481387
https://api.paperspace.io
1349-
POST /jobs/createJob { "container": "http://dockerhub.com/mycontainer", "machineType": "P6000" }
1388+
POST /jobs/createJob { "container": "http://dockerhub.com/mycontainer", "machineType": "P5000" }
13501389
x-api-key: 1ba4f98e7c0...
13511390
# Returns 201 on success</code></pre>
13521391

@@ -1362,9 +1401,9 @@ <h5>Examples</h5>
13621401
"projectId": "pr456def",
13631402
"project": "myproject",
13641403
"container": "http://dockerhub.com/mycontainer",
1365-
"machineType": "P6000",
1404+
"machineType": "P5000",
13661405
"cluster": "Jobs",
1367-
"usageRate": "P6000 hourly",
1406+
"usageRate": "P5000 hourly",
13681407
"startedByUserId": "u789ghi",
13691408
"parentJobId": null,
13701409
"jobError": null,
@@ -2163,6 +2202,32 @@ <h5>Examples</h5>
21632202
"id": "j123abc",
21642203
"name": "My Job",
21652204
"state": "running"
2205+
"id": "j123abc",
2206+
"name": "job for project myproject",
2207+
"state": "Stopped",
2208+
"workspaceUrl": "myproject.zip",
2209+
"workingDirectory": "/paperspace",
2210+
"artifactsDirectory": "/artifacts",
2211+
"entrypoint": "echo Hello Paperspace",
2212+
"projectId": "pr456def",
2213+
"project": "myproject",
2214+
"container": "http://dockerhub.com/mycontainer",
2215+
"machineType": "P5000",
2216+
"cluster": "Jobs",
2217+
"usageRate": "P5000 hourly",
2218+
"startedByUserId": "u789ghi",
2219+
"parentJobId": null,
2220+
"jobError": null,
2221+
"dtCreated": "2017-11-30T18:46:10.394Z",
2222+
"dtModified": "2017-11-30T18:46:10.394Z",
2223+
"dtProvisioningStarted": "2017-11-30T18:46:50.467Z",
2224+
"dtProvisioningFinished": "2017-11-30T18:47:12.508Z",
2225+
"dtStarted": "2017-11-30T18:47:14.636Z",
2226+
"dtFinished": "2017-11-30T18:52:44.209Z",
2227+
"dtTeardownStarted": "2017-11-30T18:52:56.889Z",
2228+
"dtTeardownFinished": "2017-11-30T18:53:31.734Z",
2229+
"dtDeleted": null,
2230+
"exitCode": 0
21662231
}
21672232
]</code></pre>
21682233

@@ -2707,6 +2772,12 @@ <h5>Examples</h5>
27072772
x-api-key: 1ba4f98e7c0...
27082773
# Returns 200 on success</code></pre>
27092774

2775+
<pre class="prettyprint"><code>//Example output:
2776+
Hello Paperspace
2777+
Creating file /artifacts/myoutput1.txt
2778+
Creating file /artifacts/myoutput2.txt
2779+
Finished; returning exit code 0</code></pre>
2780+
27102781

27112782

27122783

@@ -3085,8 +3156,31 @@ <h5>Examples</h5>
30853156
<pre class="prettyprint"><code>//Example return value:
30863157
{
30873158
"id": "j123abc",
3088-
"name": "My Job",
3089-
"state": "running",
3159+
"name": "job for project myproject",
3160+
"state": "Running",
3161+
"workspaceUrl": "myproject.zip",
3162+
"workingDirectory": "/paperspace",
3163+
"artifactsDirectory": "/artifacts",
3164+
"entrypoint": "echo Hello Paperspace",
3165+
"projectId": "pr456def",
3166+
"project": "myproject",
3167+
"container": "http://dockerhub.com/mycontainer",
3168+
"machineType": "P5000",
3169+
"cluster": "Jobs",
3170+
"usageRate": "P5000 hourly",
3171+
"startedByUserId": "u789ghi",
3172+
"parentJobId": null,
3173+
"jobError": null,
3174+
"dtCreated": "2017-11-30T18:46:10.394Z",
3175+
"dtModified": "2017-11-30T18:46:10.394Z",
3176+
"dtProvisioningStarted": "2017-11-30T18:46:50.467Z",
3177+
"dtProvisioningFinished": "2017-11-30T18:47:12.508Z",
3178+
"dtStarted": "2017-11-30T18:47:14.636Z",
3179+
"dtFinished": null,
3180+
"dtTeardownStarted": null,
3181+
"dtTeardownFinished": null,
3182+
"dtDeleted": null,
3183+
"exitCode": null
30903184
}</code></pre>
30913185

30923186

@@ -3570,8 +3664,31 @@ <h5>Examples</h5>
35703664
<pre class="prettyprint"><code>//Example return value:
35713665
{
35723666
"id": "j123abc",
3573-
"name": "My Job",
3574-
"state": "Stopped"
3667+
"name": "job for project myproject",
3668+
"state": "Stopped",
3669+
"workspaceUrl": "myproject.zip",
3670+
"workingDirectory": "/paperspace",
3671+
"artifactsDirectory": "/artifacts",
3672+
"entrypoint": "echo Hello Paperspace",
3673+
"projectId": "pr456def",
3674+
"project": "myproject",
3675+
"container": "http://dockerhub.com/mycontainer",
3676+
"machineType": "P5000",
3677+
"cluster": "Jobs",
3678+
"usageRate": "P5000 hourly",
3679+
"startedByUserId": "u789ghi",
3680+
"parentJobId": null,
3681+
"jobError": null,
3682+
"dtCreated": "2017-11-30T18:46:10.394Z",
3683+
"dtModified": "2017-11-30T18:46:10.394Z",
3684+
"dtProvisioningStarted": "2017-11-30T18:46:50.467Z",
3685+
"dtProvisioningFinished": "2017-11-30T18:47:12.508Z",
3686+
"dtStarted": "2017-11-30T18:47:14.636Z",
3687+
"dtFinished": "2017-11-30T18:52:44.209Z",
3688+
"dtTeardownStarted": "2017-11-30T18:52:56.889Z",
3689+
"dtTeardownFinished": "2017-11-30T18:53:31.734Z",
3690+
"dtDeleted": null,
3691+
"exitCode": 0
35753692
}</code></pre>
35763693

35773694

@@ -3775,7 +3892,7 @@ <h5>Returns:</h5>
37753892
<br class="clear">
37763893

37773894
<footer>
3778-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
3895+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
37793896
</footer>
37803897

37813898
<script>prettyPrint();</script>

‎docs/jobs_artifactsDestroy.js.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h1 class="page-title">jobs/artifactsDestroy.js</h1>
102102
<br class="clear">
103103

104104
<footer>
105-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
105+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
106106
</footer>
107107

108108
<script>prettyPrint();</script>

‎docs/jobs_artifactsGet.js.html‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,21 +62,24 @@ <h1 class="page-title">jobs/artifactsGet.js</h1>
6262
* @returns one or more artifact files
6363
* @example
6464
* paperspace.jobs.artifactsGet({
65-
* jobId: 'j123abc',
66-
* files: 'myfiles*' // optional
65+
* jobId: 'j123abc'
6766
* }, function(err, res) {
6867
* // handle error or result
6968
* });
7069
* @example
7170
* $ paperspace jobs artifactsGet \
72-
* --jobId "j123abc" \
73-
* --files "myfiles*"
71+
* --jobId "j123abc"
7472
* @example
7573
* # HTTP request:
7674
* https://api.paperspace.io
7775
* GET /jobs/artifactsGet?jobId=j123abc&amp;files=myfiles*
7876
* x-api-key: 1ba4f98e7c0...
7977
* # Returns 200 on success
78+
* @example
79+
* //Example output:
80+
* Downloading myoutput1.txt
81+
* Downloading myoutput2.txt
82+
* Downloads finished
8083
*/
8184

8285
function expandHomeDir(pathIn) {
@@ -277,7 +280,7 @@ <h1 class="page-title">jobs/artifactsGet.js</h1>
277280
<br class="clear">
278281

279282
<footer>
280-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
283+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
281284
</footer>
282285

283286
<script>prettyPrint();</script>

‎docs/jobs_artifactsList.js.html‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,18 +56,31 @@ <h1 class="page-title">jobs/artifactsList.js</h1>
5656
* @example
5757
* paperspace.jobs.artifactsList({
5858
* jobId: 'j123abc',
59+
* size: true
5960
* }, function(err, res) {
6061
* // handle error or result
6162
* });
6263
* @example
6364
* $ paperspace jobs artifactsList \
64-
* --jobId "j123abc"
65+
* --jobId "j123abc" \
66+
* --size true
6567
* @example
6668
* # HTTP request:
6769
* https://api.paperspace.io
6870
* GET /jobs/artifactsList?jobId=j123abc
6971
* x-api-key: 1ba4f98e7c0...
7072
* # Returns 200 on success
73+
* //Example return value:
74+
* [
75+
* {
76+
* "file": "myoutput1.txt"
77+
* "size": 443141
78+
* },
79+
* {
80+
* "file": "myoutput2.txt"
81+
* "size": 1456
82+
* }
83+
* ]
7184
*/
7285

7386
function artifactsList(params, cb) {
@@ -120,7 +133,7 @@ <h1 class="page-title">jobs/artifactsList.js</h1>
120133
<br class="clear">
121134

122135
<footer>
123-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
136+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
124137
</footer>
125138

126139
<script>prettyPrint();</script>

‎docs/jobs_clone.js.html‎

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,31 @@ <h1 class="page-title">jobs/clone.js</h1>
6868
* //Example return value:
6969
* {
7070
* "id": "j345abc",
71-
* "name": "My Job",
72-
* "state": "running",
71+
* "name": "job for project myproject",
72+
* "state": "Pending",
73+
* "workspaceUrl": "myproject.zip",
74+
* "workingDirectory": "/paperspace",
75+
* "artifactsDirectory": "/artifacts",
76+
* "entrypoint": "echo Hello Paperspace",
77+
* "projectId": "pr456def",
78+
* "project": "myproject",
79+
* "container": "http://dockerhub.com/mycontainer",
80+
* "machineType": "P5000",
81+
* "cluster": "Jobs",
82+
* "usageRate": "P5000 hourly",
83+
* "startedByUserId": "u789ghi",
84+
* "parentJobId": "j123abc",
85+
* "jobError": null,
86+
* "dtCreated": "2017-11-30T19:20:38.956Z",
87+
* "dtModified": "2017-11-30T19:20:39.744Z",
88+
* "dtProvisioningStarted": null,
89+
* "dtProvisioningFinished": null,
90+
* "dtStarted": null,
91+
* "dtFinished": null,
92+
* "dtTeardownStarted": null,
93+
* "dtTeardownFinished": null,
94+
* "dtDeleted": null,
95+
* "exitCode": null
7396
* }
7497
*/
7598

@@ -107,7 +130,7 @@ <h1 class="page-title">jobs/clone.js</h1>
107130
<br class="clear">
108131

109132
<footer>
110-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Dec 19 2017 23:31:24 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
133+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Jan 02 2018 20:38:44 GMT-0500 (EST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
111134
</footer>
112135

113136
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)