Project status: pre-alpha
This is the active Guild source repository.
Guild has been rewritten in Python and has undergone substantial changes since its original release.
Installing Guild AI
Preliminary releases of Linux wheels are available on PyPI. To install the latest version, run:
$ pip install guildai --upgrade
If your platform isn't support, you can compile Guild AI from source (see steps below).
Compiling Guild AI from source
Guild Python requires Bazel 0.5.4 or higher to build. See Installing Bazel for help with you system.
Clone Guild Python from GitHub:
$ git clone https://github.com/guildai/guild-python.git
Build Guild Python using the
$ cd guild-python $ bazel build guild
You may alternatively simply run
The initial Guild Python build will take some time as Bazel will download several dependencies, including TensorBoard. Subsequent builds will run faster.
If Guild Python builds successfully, run the
check command with
$ bazel-bin/guild/guild check --tests
You may alternatively run
Please report any failed tests to the project GitHub issue tracker.
guild without typing its full path, create an alias:
$GUILD_REPO is a reference to your local Guild git repository.
Using Guild AI
Clone the Guild Examples:
$ git clone https://github.com/guildai/guild-examples.git
Change to the
mnist2 example and train the default model:
$ cd guild-examples/mnist2 $ guild train
You will be asked to confirm that you want to train the
model. Press enter to continue.
Guild will train the MNIST intro model, which is a simple softmax regression. It should only take a view seconds to train.
In a second terminal, change to the
mnist2 example directory and
start Guild View:
$ cd guild-examples/mnist2 $ guild view
This will open TensorBoard where you can view the runs for the
Guild documentation is under development and not yet available. Use the command line help to familiarize yourself with Guild's features.
||List available Guild commands|
||Show help for