The following is a minimal SSH remote configuration. Runs are located on the remote host under the Guild home
~ is the home directory for the default user associated with
remotes: ssh-remote: type: ssh description: Remote runs host: remote-hostname
ssh defaults are specified according to the SSH implementation on the local (client) system. Refer to the documentation for your SSH client for details on configuring defaults.
The next example defines additional SSH settings as well as a Guild environment.
remotes: production: type: ssh description: Production runs host: remote-hostname user: ubuntu port: 2222 guild-env: ~/Envs/production init: test -e ~/Envs/production || guild init -y ~/Envs/production
init defines a command that creates a Guild environment if one doesn’t exist. Use
guild remote start production --reinit to ensure that the environment is setup correctly before running Guild commands.
The following is a minimal example of an EC2 remote:
remotes: ec2-v100: type: ec2 description: NVIDIA V100 on EC2 region: us-east-2 ami: ami-0a47106e391391252 instance-type: p3.2xlarge public-key: ~/.ssh/id_rsa.pub user: ubuntu
The following example stores runs directly in
remotes: s3-production: type: s3 description: Production runs bucket: my-s3-production-runs
You can use
root to store runs under a bucket path.
remotes: s3-test: type: s3 description: Test runs bucket: my-s3-runs root: test s3-production: type: s3 description: Production runs bucket: my-s3-runs root: production
The following example stores in the
default folder in the specified container. Note that
root is optional.
remotes: azure-dev: type: azure-blob description: Development runs container: https://myco.blob.core.windows.net/guild-dev-runs
The following example stores runs in a GitHub gist for user
jack. The gist is identified using a specially named Guild README file containing the gist name
remotes: shared: type: gist user: jack gist-name: shared-runs
To write to this gist, specify a gist-authorized personal access token with the environment variable