- ssh remote
- ec2 remote
- s3 remote
User configuration is defined in
~/.guild/config.yml. It defines
configuration and settings that Guild uses on a per-user basis.
Remotes are defined under a top-level
remotes object. Each remote is
named using its
remotes section key.
remotes: remote-1: ... remote-2: ... remote-3: ...
For information on using remotes, see Remotes.
Remotes are classified by their type, which is specified using the
type attribute. Each remote must define its type as one of the
By default, port
22 is used for SSH connections.
By default, the active user name is used for SSH connections.
Specify this value to use an alternative Guild home location on the
remote server. By default, the
.guild relative path is
used. Relative paths are typically considered relative to the user
home directory, but this may be different depending on the active
user’s SSH configuration. If
guild‑env is specified, relative
paths are considered relative to the Guild environment location.
If this value is specified, Guild will active the environment on the remote server before running commands.
‑‑preflag when installing required packages (boolean)
By default, Guild does not install pre-release package versions when
installing required packages for a run. If you want to install
pre-release packages, set this value to
deep‑learning with IP address
remotes: deep-learning: type: ssh host: 192.168.1.101
big‑server that’s accessed over the Internet over a
non-standard port using a Guild environment:
remotes: big-server: host: big.my.co port: 2202 user: ubuntu guild-env: ~/sample-project/env
ec2 remotes share all of the attribute of
ssh remotes. See above
In addition to the
ec2 remotes support the following:
This value must be specified to access the remote server unless the server configures a public key some other way (e.g. the key is on the AMI, etc.)
CAUTION: Passwords are stored in plain text and should not be used for sensitive applications. To avoid revealing passwords, use SSH public/private key authentication.
k80 used to start a
p2.xlarge instance in
remotes: k80: type: ec2 region: us-east-2 ami: ami-4f62582a instance-type: p2.xlarge public-key: ~/.ssh/id_rsa.pub user: ubuntu init: | set -ex cat > ~/.bashrc << EOF export LD_LIBRARY_PATH=/usr/local/cuda/lib64 EOF . ~/.bashrc sudo pip install --upgrade pip sudo pip install --upgrade guildai sudo pip install --upgrade tensorflow-gpu guild check
By default the root of the bucket is used.
By default the environment variable
AWS_DEFAULT_REGION is used for
s3‑backup that uses the S3 bucket
remotes: s3-backup: bucket: deep-learning-backups
Project specific remote named
s3‑my‑project that uses a sub-folder
of the S3 bucket
remotes: s3-my-project: bucket: deep-learning-backups root: my-project
The diff command uses the
diff program by default. You can
specify an alternative command by creating a
diff top-level object.
The command will be invoked as specified with two additional arguments: the first and second run paths to diff.
Use Meld to diff runs:
diff: command: meld
Use colordiff to diff runs:
diff: command: colordiff -ru