# Reference

**URL:** https://guildai.org/c/docs/reference/18.md

[Latest](https://guildai.org/latest.md) · [Categories](https://guildai.org/categories.md)

---

## [Guild File Reference](https://guildai.org/t/guild-file-reference/197)

<div class="topic-metadata">

**Author:** [@guildai](https://guildai.org/u/guildai)\
**Replies:** 0\
**Last updated:** [June 21, 2020, 4:10pm UTC](https://guildai.org/t/guild-file-reference/197 "2020-06-21T16:10:10Z")

</div>

Guild File Format Guild files are named guild.yml. They contain Guild AI related project configuration. This document describes their format and schema. Guild files are plain text, YAML formatted files. Guild files …

---

## [Remotes Reference](https://guildai.org/t/remotes-reference/172)

<div class="topic-metadata">

**Author:** [@guildai](https://guildai.org/u/guildai)\
**Replies:** 0\
**Last updated:** [June 13, 2020, 1:53am UTC](https://guildai.org/t/remotes-reference/172 "2020-06-13T01:53:17Z")

</div>

Overview This reference documents remote types, their supported attributes, and provides examples. A remote type is defined using the type attribute. The types below are supported. Refer to the applicable section belo…

---

## [User Config Reference](https://guildai.org/t/user-config-reference/173)

<div class="topic-metadata">

**Author:** [@guildai](https://guildai.org/u/guildai)\
**Replies:** 3\
**Last updated:** [January 3, 2022, 5:45pm UTC](https://guildai.org/t/user-config-reference/173 "2022-01-03T17:45:12Z")

</div>

Overview Guild user configuration can be specified using one of three methods: In ~/.guild/config.yml (default) In guild-config.yml located in the current working directory (e.g. defined alongside guild.yml in a proj…

---

## [Plugins Reference](https://guildai.org/t/plugins-reference/174)

<div class="topic-metadata">

**Author:** [@guildai](https://guildai.org/u/guildai)\
**Replies:** 0\
**Last updated:** [June 13, 2020, 1:55am UTC](https://guildai.org/t/plugins-reference/174 "2020-06-13T01:55:21Z")

</div>

Overview Guild supports a plugin API that is used to modify and extend Guild behavior. Guild plugins can be used for the following functions: Extend or modify Guild file configuration Perform tasks during a run Prov…

---

## [Optimizers Reference](https://guildai.org/t/optimizers-reference/43)

<div class="topic-metadata">

**Author:** [@guildai](https://guildai.org/u/guildai)\
**Replies:** 0\
**Last updated:** [June 7, 2020, 12:36am UTC](https://guildai.org/t/optimizers-reference/43 "2020-06-07T00:36:46Z")

</div>

Overview An optimizer is a Guild operation that runs a batch. A batch generates one or more trial runs or trials. Optimizers are able to suggest flag values to minimize or maximize an objective. Below is a list of sup…

---

## [About the Reference category](https://guildai.org/t/about-the-reference-category/26)

<div class="topic-metadata">

**Author:** [@guildai](https://guildai.org/u/guildai)\
**Replies:** 0\
**Last updated:** [June 6, 2020, 2:46pm UTC](https://guildai.org/t/about-the-reference-category/26 "2020-06-06T14:46:42Z")

</div>

Guild AI reference documents.
