How it works
A sandbox is a single isolated compute environment. You create it, run commands inside it, and stop it when it is done. Each sandbox runs in its own container with its own filesystem, network, and process space. Sandboxes authenticate using your existing W&B credentials. Use the W&B Secrets Manager with the W&B Python SDK to access sensitive information such as API keys and tokens in a sandbox. A sandbox goes through several states in its lifecycle. When a container is running, you can execute commands inside it. Read, write, and mount read-only files to and from the sandbox. Common examples include reading in a Python script to execute, writing out logs or results, or mounting a directory of data read-only for the sandbox to access. Use a session to manage multiple sandboxes that share configuration. When a session closes, all of its sandboxes are stopped automatically. See Manage multiple sandboxes for more details.Basic usage
Copy and paste the following code snippet into a Python file and run it. You should see the outputHello from W&B Sandboxes! printed to the console.
- Create a sandbox with
Sandbox.run(). - Run the command
echo "Hello from W&B Sandboxes!"inside the sandbox using theSandbox.exec()method. - Print the output to the console using the
Processobject returned bySandbox.exec().
hello_sandbox.py
with block) exits. For more information on sandbox lifecycle and states, see Lifecycle of sandboxes.