Run on Spell Button

The "Run on Spell" button allows you to share copies of your runs or workspaces with other users in a public or private way.

How it works

The Spell web console allows logged-in users to launch new runs and/or workspaces right from the web. The launch URL can optionally be paramaterized using URL query strings. Parameterizing this with the exact GitHub repo, code packages, and resources, that you used when you created the notebook will allow anyone with access to the code and the resources to spin up their own copy of your run or workspace in their own account.

We provide a badge, similar to one you might create with shields.io, that lets you share these links in an attractive way:

These badges are suitable for placement in your README.md on GitHub.

The runs page accepts the following URL parameters (note that special characters, like spaces, must be percent-encoded in order to work):

Parameter Example
command https://web.spell.ml/createrun?command=echo%20hello
machineType https://web.spell.ml/createrun?command=echo%20hi&machineType=K80
distributed https://web.spell.ml/createrun?command=echo%20hi&machineType=K80&distributed=2
githubUrl https://web.spell.ml/createrun?command=echo%20hi&githubUrl=https%3A%2F%2Fgithub.com%2Fspellml%2Fexamples
githubCommitHash https://web.spell.ml/createrun?command=echo%20hi&githubUrl=https%3A%2F%2Fgithub.com%2Fspellml%2Fexamples&gitCommitHash=bayesopt
cwd https://web.spell.ml/createrun?command=echo%20hi&githubUrl=https%3A%2F%2Fgithub.com%2Fspellml%2Fexamples&cwd=.%2Fspot
framework https://web.spell.ml/createrun?command=echo%20hi&framework=tensorflow2
apt https://web.spell.ml/createrun?command=echo%20hi&apt=foo,bar
pip https://web.spell.ml/createrun?command=echo%20hi&pip=foo,bar
condaEnvFile (omitted)
dockerImage https://web.spell.ml/createrun?command=echo%20hi&dockerImage=spellrun%2Ftensorflow
envVars https://web.spell.ml/createrun?command=echo%20hi&envVars=FOO%3DBAR
mounts https://web.spell.ml/createrun?command=echo%20hi&mounts=a%3Ab%26mounts=c%3Ad
tensorboardEnabled
tensorboardDirectory
https://web.spell.ml/createrun?command=echo%20hi&tensorboardDirectory=%2Ftensorboard&tensorboardEnabled=true
notes https://web.spell.ml/createrun?command=echo%20hi┬Čes=hi
stopCondition https://web.spell.ml/createrun?command=echo%20hi&stopCondition=metric1%3C10

An example run-on-Spell button for a Spell run formated in Markdown:

[![](https://spell.ml/badge.svg)](https://web.spell.ml/createrun?command=echo%20hi)

An example run-on-Spell button for a Spell run formated in HTML:

<a href="https://web.spell.ml/createrun?command=echo%20hi">
    <img src="https://spell.ml/badge.svg"/>
</a>

The workspaces page accepts the following URL parameters (note that special characters, like spaces, must be percent-encoded in order to work):

Parameter Example
workspaceName https://web.spell.ml/workspace_create?workspaceName=hi
githubUrl https://web.spell.ml/workspace_create?workspaceName=hi&githubUrl=https%3A%2F%2Fgithub.com%2Fspellml%2Fexamples
machineType https://web.spell.ml/workspace_create?workspaceName=hi&machineType=K80
framework https://web.spell.ml/workspace_create?workspaceName=hi&framework=tensorflow2
apt https://web.spell.ml/workspace_create?workspaceName=hi&apt=foo,bar
pip https://web.spell.ml/workspace_create?workspaceName=hi&pip=foo,bar
condaEnvFile (omitted)
dockerImage https://web.spell.ml/workspace_create?workspaceName=hi&dockerImage=spellrun%2Ftensorflow
envVars https://web.spell.ml/workspace_create?workspaceName=hi&envVars=FOO%3DBAR
isLab https://web.spell.ml/workspace_create?workspaceName=hi&isLab=false
idleKernelTimeoutMinutes https://web.spell.ml/workspace_create?workspaceName=hi&idleKernelTimeoutMinutes=60
mounts https://web.spell.ml/workspace_create?workspaceName=hi&mounts=a%3Ab%26mounts=c%3Ad

An example run-on-Spell button for a Spell workspace formated in Markdown:

[![](https://spell.ml/badge.svg)](https://web.spell.ml/workspace_create?workspaceName=hi&githubUrl=https%3A%2F%2Fgithub.com%2Fspellml%2Fexamples)

An example run-on-Spell button for a Spell workspace formated in HTML:

<a href="https://web.spell.ml/workspace_create?workspaceName=hi&githubUrl=https%3A%2F%2Fgithub.com%2Fspellml%2Fexamples">
    <img src="https://spell.ml/badge.svg"/>
</a>