Paperspace API (v0.1.13)
+Paperspace API (v0.1.14)
Heads up! This project is under construction! We welcome your bug reports and suggestions via GitHub Issues!
@@ -58,7 +58,7 @@Home
Namespaces
- API documentation
- Script Guide for creating and using startup scripts
Release Notes
+Release Notes
Getting started
Installation
Option 1: Download the pre-built 'paperspace' binary for your plaftorm
@@ -83,7 +83,7 @@Option 1: Obtain an API k
Note: your API key is cached in a file in your home directory: ~/.papersapce/config.json. For security, please make sure access to the file is protected so only you can access it.
You can clear your locally cached API key at any time by executing:
$ paperspace logout-Note: Currently only email login is supported in the CLI - if you're using AD, SAML or GitHub to login to Paperspace, you will need t obtain an API key to log in with the CLI.
+Note: Currently only email login is supported in the CLI - if you're using AD, SAML or GitHub to login to Paperspace, you will need t obtain an API key to log in with the CLI.
Option 2: Obtain an API key via your Paperspace Console
Alternatively you can create an API key from within your Paperspace console under the API section. Login to your Paperspace console, scroll to the API section in the left navigation bar, and click CREATE AN API KEY. Follow the instructions there.
@@ -161,7 +161,7 @@Copyright
diff --git a/docs/jobs.html b/docs/jobs.html index 406fca4..cda3845 100644 --- a/docs/jobs.html +++ b/docs/jobs.html @@ -4964,7 +4964,7 @@
Returns:
diff --git a/docs/jobs_artifactsDestroy.js.html b/docs/jobs_artifactsDestroy.js.html index 1946353..71037e7 100644 --- a/docs/jobs_artifactsDestroy.js.html +++ b/docs/jobs_artifactsDestroy.js.html @@ -102,7 +102,7 @@
jobs/artifactsDestroy.js
diff --git a/docs/jobs_artifactsGet.js.html b/docs/jobs_artifactsGet.js.html index 73a8623..af98e1e 100644 --- a/docs/jobs_artifactsGet.js.html +++ b/docs/jobs_artifactsGet.js.html @@ -280,7 +280,7 @@
jobs/artifactsGet.js
diff --git a/docs/jobs_artifactsList.js.html b/docs/jobs_artifactsList.js.html index 291d08e..6a487cf 100644 --- a/docs/jobs_artifactsList.js.html +++ b/docs/jobs_artifactsList.js.html @@ -133,7 +133,7 @@
jobs/artifactsList.js
diff --git a/docs/jobs_clone.js.html b/docs/jobs_clone.js.html index 3786c2e..11fb525 100644 --- a/docs/jobs_clone.js.html +++ b/docs/jobs_clone.js.html @@ -130,7 +130,7 @@
jobs/clone.js
diff --git a/docs/jobs_create.js.html b/docs/jobs_create.js.html index c1fb802..747cd6a 100644 --- a/docs/jobs_create.js.html +++ b/docs/jobs_create.js.html @@ -580,7 +580,7 @@
jobs/create.js
diff --git a/docs/jobs_destroy.js.html b/docs/jobs_destroy.js.html index 080ee18..b3ec05e 100644 --- a/docs/jobs_destroy.js.html +++ b/docs/jobs_destroy.js.html @@ -103,7 +103,7 @@
jobs/destroy.js
diff --git a/docs/jobs_index.js.html b/docs/jobs_index.js.html index c7e8b7d..4196198 100644 --- a/docs/jobs_index.js.html +++ b/docs/jobs_index.js.html @@ -69,7 +69,7 @@
jobs/index.js
diff --git a/docs/jobs_list.js.html b/docs/jobs_list.js.html index 34f2544..6ff332c 100644 --- a/docs/jobs_list.js.html +++ b/docs/jobs_list.js.html @@ -207,7 +207,7 @@
jobs/list.js
diff --git a/docs/jobs_logs.js.html b/docs/jobs_logs.js.html index 0417934..ee62d80 100644 --- a/docs/jobs_logs.js.html +++ b/docs/jobs_logs.js.html @@ -196,7 +196,7 @@
jobs/logs.js
diff --git a/docs/jobs_machineTypes.js.html b/docs/jobs_machineTypes.js.html index 767b847..b4565a9 100644 --- a/docs/jobs_machineTypes.js.html +++ b/docs/jobs_machineTypes.js.html @@ -128,7 +128,7 @@
jobs/machineTypes.js
diff --git a/docs/jobs_show.js.html b/docs/jobs_show.js.html index 1460b94..af00e43 100644 --- a/docs/jobs_show.js.html +++ b/docs/jobs_show.js.html @@ -128,7 +128,7 @@
jobs/show.js
diff --git a/docs/jobs_stop.js.html b/docs/jobs_stop.js.html index b129b94..1bef520 100644 --- a/docs/jobs_stop.js.html +++ b/docs/jobs_stop.js.html @@ -97,7 +97,7 @@
jobs/stop.js
diff --git a/docs/jobs_waitfor.js.html b/docs/jobs_waitfor.js.html index 102de3e..9c395e7 100644 --- a/docs/jobs_waitfor.js.html +++ b/docs/jobs_waitfor.js.html @@ -180,7 +180,7 @@
jobs/waitfor.js
diff --git a/docs/login.html b/docs/login.html index 71944d3..83f2d8d 100644 --- a/docs/login.html +++ b/docs/login.html @@ -433,7 +433,7 @@
Properties
diff --git a/docs/login_index.js.html b/docs/login_index.js.html index 5c5d6c1..7f7ed35 100644 --- a/docs/login_index.js.html +++ b/docs/login_index.js.html @@ -58,7 +58,7 @@
login/index.js
diff --git a/docs/login_user.js.html b/docs/login_user.js.html index 74c7678..471c052 100644 --- a/docs/login_user.js.html +++ b/docs/login_user.js.html @@ -123,7 +123,7 @@
login/user.js
diff --git a/docs/logout.html b/docs/logout.html index a0b0995..9dc560a 100644 --- a/docs/logout.html +++ b/docs/logout.html @@ -278,7 +278,7 @@
Parameters:
diff --git a/docs/logout_index.js.html b/docs/logout_index.js.html index 31dc3c7..349310c 100644 --- a/docs/logout_index.js.html +++ b/docs/logout_index.js.html @@ -58,7 +58,7 @@
logout/index.js
diff --git a/docs/logout_user.js.html b/docs/logout_user.js.html index 21aee8e..7cb47a1 100644 --- a/docs/logout_user.js.html +++ b/docs/logout_user.js.html @@ -75,7 +75,7 @@
logout/user.js
diff --git a/docs/machines.html b/docs/machines.html index 9dedf6b..aac93d4 100644 --- a/docs/machines.html +++ b/docs/machines.html @@ -4688,7 +4688,7 @@
Returns:
diff --git a/docs/machines_availability.js.html b/docs/machines_availability.js.html index 9f7cb98..a858d4f 100644 --- a/docs/machines_availability.js.html +++ b/docs/machines_availability.js.html @@ -105,7 +105,7 @@
machines/availability.js
diff --git a/docs/machines_create.js.html b/docs/machines_create.js.html index 723c001..9561156 100644 --- a/docs/machines_create.js.html +++ b/docs/machines_create.js.html @@ -192,7 +192,7 @@
machines/create.js
diff --git a/docs/machines_destroy.js.html b/docs/machines_destroy.js.html index 9818fb5..43a13b4 100644 --- a/docs/machines_destroy.js.html +++ b/docs/machines_destroy.js.html @@ -100,7 +100,7 @@
machines/destroy.js
diff --git a/docs/machines_index.js.html b/docs/machines_index.js.html index e8e03e1..0f64037 100644 --- a/docs/machines_index.js.html +++ b/docs/machines_index.js.html @@ -68,7 +68,7 @@
machines/index.js
diff --git a/docs/machines_list.js.html b/docs/machines_list.js.html index 420db9e..4a4d8e4 100644 --- a/docs/machines_list.js.html +++ b/docs/machines_list.js.html @@ -150,7 +150,7 @@
machines/list.js
diff --git a/docs/machines_restart.js.html b/docs/machines_restart.js.html index b46e63c..03b1d11 100644 --- a/docs/machines_restart.js.html +++ b/docs/machines_restart.js.html @@ -96,7 +96,7 @@
machines/restart.js
diff --git a/docs/machines_show.js.html b/docs/machines_show.js.html index 24086a9..1332339 100644 --- a/docs/machines_show.js.html +++ b/docs/machines_show.js.html @@ -173,7 +173,7 @@
machines/show.js
diff --git a/docs/machines_start.js.html b/docs/machines_start.js.html index c05241d..4ee6af3 100644 --- a/docs/machines_start.js.html +++ b/docs/machines_start.js.html @@ -96,7 +96,7 @@
machines/start.js
diff --git a/docs/machines_stop.js.html b/docs/machines_stop.js.html index 21adb74..3335597 100644 --- a/docs/machines_stop.js.html +++ b/docs/machines_stop.js.html @@ -97,7 +97,7 @@
machines/stop.js
diff --git a/docs/machines_update.js.html b/docs/machines_update.js.html index ac6b993..455ad0b 100644 --- a/docs/machines_update.js.html +++ b/docs/machines_update.js.html @@ -114,7 +114,7 @@
machines/update.js
diff --git a/docs/machines_utilization.js.html b/docs/machines_utilization.js.html index 067cf75..362f63a 100644 --- a/docs/machines_utilization.js.html +++ b/docs/machines_utilization.js.html @@ -117,7 +117,7 @@
machines/utilization.js
diff --git a/docs/machines_waitfor.js.html b/docs/machines_waitfor.js.html index d01bc03..50a55a1 100644 --- a/docs/machines_waitfor.js.html +++ b/docs/machines_waitfor.js.html @@ -163,7 +163,7 @@
machines/waitfor.js
diff --git a/docs/networks.html b/docs/networks.html index 65517a8..f93ea5b 100644 --- a/docs/networks.html +++ b/docs/networks.html @@ -620,7 +620,7 @@
Returns:
diff --git a/docs/networks_index.js.html b/docs/networks_index.js.html index a6a1f6b..964b623 100644 --- a/docs/networks_index.js.html +++ b/docs/networks_index.js.html @@ -58,7 +58,7 @@
networks/index.js
diff --git a/docs/networks_list.js.html b/docs/networks_list.js.html index e40dedf..8edc238 100644 --- a/docs/networks_list.js.html +++ b/docs/networks_list.js.html @@ -112,7 +112,7 @@
networks/list.js
diff --git a/docs/project.html b/docs/project.html index 7906e52..de66c40 100644 --- a/docs/project.html +++ b/docs/project.html @@ -693,7 +693,7 @@
Returns:
diff --git a/docs/project_clear.js.html b/docs/project_clear.js.html index 2b8a43b..389b679 100644 --- a/docs/project_clear.js.html +++ b/docs/project_clear.js.html @@ -81,7 +81,7 @@
project/clear.js
diff --git a/docs/project_index.js.html b/docs/project_index.js.html index 7b91166..8d2492d 100644 --- a/docs/project_index.js.html +++ b/docs/project_index.js.html @@ -60,7 +60,7 @@
project/index.js
diff --git a/docs/project_init.js.html b/docs/project_init.js.html index c782c97..8d1da56 100644 --- a/docs/project_init.js.html +++ b/docs/project_init.js.html @@ -120,7 +120,7 @@
project/init.js
diff --git a/docs/project_show.js.html b/docs/project_show.js.html index 1bc2841..6552f2c 100644 --- a/docs/project_show.js.html +++ b/docs/project_show.js.html @@ -81,7 +81,7 @@
project/show.js
diff --git a/docs/releasenotes.md b/docs/releasenotes.md index e4b7c3c..043446c 100644 --- a/docs/releasenotes.md +++ b/docs/releasenotes.md @@ -1,21 +1,27 @@ # Paperspace API Release Notes +## Release Notes for v0.1.14 + +#### New features + +* Add support for resourceDelegations + ## Release Notes for v0.1.13 #### New features * Run gradient jobs from custom Dockerfile built containers (see: https://docs.paperspace.com/gradient/jobs/create-a-job#new-run-jobs-from-dockerfiles) -* Push GPU-enabled container images to a registry of your choice +* Push GPU-enabled container images to a registry of your choice -* Add support for yarn package manager +* Add support for yarn package manager ### Fixes -* Add custom headers to requests +* Add custom headers to requests ## Release Notes for v0.1.12 #### New features -* Send jobs to preeemptible instances by using the new `--isPreemptible` flag to save up to 65% on jobs! See https://support.paperspace.com/hc/en-us/articles/360015388374 for more info. +* Send jobs to preeemptible instances by using the new `--isPreemptible` flag to save up to 65% on jobs! See https://support.paperspace.com/hc/en-us/articles/360015388374 for more info. * Ability to ignore certain files in your workspace directory using the new `--ignoreFiles` flag @@ -33,7 +39,7 @@ * Raised job workspace upload limit to 500 MB ### Fixes -* Fix for job create returning before final job state known but after logs received +* Fix for job create returning before final job state known but after logs received ## Release Notes for v0.1.10 diff --git a/docs/resourceDelegations.html b/docs/resourceDelegations.html index ca7a607..ff9923c 100644 --- a/docs/resourceDelegations.html +++ b/docs/resourceDelegations.html @@ -501,7 +501,7 @@
Returns:
diff --git a/docs/resourceDelegations_create.js.html b/docs/resourceDelegations_create.js.html index 22f1b50..bff9db6 100644 --- a/docs/resourceDelegations_create.js.html +++ b/docs/resourceDelegations_create.js.html @@ -125,7 +125,7 @@
resourceDelegations/create.js
diff --git a/docs/resourceDelegations_index.js.html b/docs/resourceDelegations_index.js.html index c6b2fea..191fae6 100644 --- a/docs/resourceDelegations_index.js.html +++ b/docs/resourceDelegations_index.js.html @@ -58,7 +58,7 @@
resourceDelegations/index.js
diff --git a/docs/scripts.html b/docs/scripts.html index eed809e..39456fb 100644 --- a/docs/scripts.html +++ b/docs/scripts.html @@ -1872,7 +1872,7 @@
Returns:
diff --git a/docs/scripts_create.js.html b/docs/scripts_create.js.html index c9173d1..e3ae0e7 100644 --- a/docs/scripts_create.js.html +++ b/docs/scripts_create.js.html @@ -131,7 +131,7 @@
scripts/create.js
diff --git a/docs/scripts_destroy.js.html b/docs/scripts_destroy.js.html index 6df41dc..f87b65f 100644 --- a/docs/scripts_destroy.js.html +++ b/docs/scripts_destroy.js.html @@ -95,7 +95,7 @@
scripts/destroy.js
diff --git a/docs/scripts_index.js.html b/docs/scripts_index.js.html index e943f4b..9164e96 100644 --- a/docs/scripts_index.js.html +++ b/docs/scripts_index.js.html @@ -63,7 +63,7 @@
scripts/index.js
diff --git a/docs/scripts_list.js.html b/docs/scripts_list.js.html index d5e93ec..1f51cd4 100644 --- a/docs/scripts_list.js.html +++ b/docs/scripts_list.js.html @@ -114,7 +114,7 @@
scripts/list.js
diff --git a/docs/scripts_show.js.html b/docs/scripts_show.js.html index 11dc90d..5c516ed 100644 --- a/docs/scripts_show.js.html +++ b/docs/scripts_show.js.html @@ -119,7 +119,7 @@
scripts/show.js
diff --git a/docs/scripts_text.js.html b/docs/scripts_text.js.html index a8de4ee..eb25b74 100644 --- a/docs/scripts_text.js.html +++ b/docs/scripts_text.js.html @@ -99,7 +99,7 @@
scripts/text.js
diff --git a/docs/templates.html b/docs/templates.html index 1b212e5..71f77e4 100644 --- a/docs/templates.html +++ b/docs/templates.html @@ -663,7 +663,7 @@
Returns:
diff --git a/docs/templates_index.js.html b/docs/templates_index.js.html index 4bd8b15..4f079fc 100644 --- a/docs/templates_index.js.html +++ b/docs/templates_index.js.html @@ -58,7 +58,7 @@
templates/index.js
diff --git a/docs/templates_list.js.html b/docs/templates_list.js.html index a4c0a5a..2bbbc9a 100644 --- a/docs/templates_list.js.html +++ b/docs/templates_list.js.html @@ -123,7 +123,7 @@
templates/list.js
diff --git a/docs/users.html b/docs/users.html index 70fecef..99903a3 100644 --- a/docs/users.html +++ b/docs/users.html @@ -594,7 +594,7 @@
Returns:
diff --git a/docs/users_index.js.html b/docs/users_index.js.html index 7dbb628..e1c65ba 100644 --- a/docs/users_index.js.html +++ b/docs/users_index.js.html @@ -58,7 +58,7 @@
users/index.js
diff --git a/docs/users_list.js.html b/docs/users_list.js.html index e0a460b..8981112 100644 --- a/docs/users_list.js.html +++ b/docs/users_list.js.html @@ -118,7 +118,7 @@
users/list.js
diff --git a/package.json b/package.json index 870e8b5..52a7ac1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "paperspace-node", - "version": "0.1.13", + "version": "0.1.14", "description": "Paperspace API for node", "main": "index.js", "repository": "https://github.com/Paperspace/paperspace-node", diff --git a/releasenotes.md b/releasenotes.md index e4b7c3c..043446c 100644 --- a/releasenotes.md +++ b/releasenotes.md @@ -1,21 +1,27 @@ # Paperspace API Release Notes +## Release Notes for v0.1.14 + +#### New features + +* Add support for resourceDelegations + ## Release Notes for v0.1.13 #### New features * Run gradient jobs from custom Dockerfile built containers (see: https://docs.paperspace.com/gradient/jobs/create-a-job#new-run-jobs-from-dockerfiles) -* Push GPU-enabled container images to a registry of your choice +* Push GPU-enabled container images to a registry of your choice -* Add support for yarn package manager +* Add support for yarn package manager ### Fixes -* Add custom headers to requests +* Add custom headers to requests ## Release Notes for v0.1.12 #### New features -* Send jobs to preeemptible instances by using the new `--isPreemptible` flag to save up to 65% on jobs! See https://support.paperspace.com/hc/en-us/articles/360015388374 for more info. +* Send jobs to preeemptible instances by using the new `--isPreemptible` flag to save up to 65% on jobs! See https://support.paperspace.com/hc/en-us/articles/360015388374 for more info. * Ability to ignore certain files in your workspace directory using the new `--ignoreFiles` flag @@ -33,7 +39,7 @@ * Raised job workspace upload limit to 500 MB ### Fixes -* Fix for job create returning before final job state known but after logs received +* Fix for job create returning before final job state known but after logs received ## Release Notes for v0.1.10