https://github.com/guildai/my-guild-ai
https://github.com/guildai/my-guild-ai
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/guildai/my-guild-ai
- Owner: guildai
- License: apache-2.0
- Created: 2020-06-09T16:01:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-31T18:47:02.000Z (almost 3 years ago)
- Last Synced: 2025-03-10T19:25:31.519Z (over 1 year ago)
- Language: Python
- Size: 81.4 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# my.guild.ai
## Setup
Install this toolkit by running:
```
python setup.py develop
```
## Process
### Refresh All Commands
Do this on a new feature release or when the command template changes.
IMPORTANT: The published commands will reflect the currently installed
version of Guild. Be certain to check out the appropriate commit/tag
when generating command help from a source code based version of
Guild.
$ cd ~/SCM/guild
$ git checkout VERSION-TAG
Clear the my-guild cache.
$ cd ~/SCM/my-guild-ai
$ my-guild clear-cache --all
Publish the commands.
$ my-guild publish-docs
## CLI
Run `my-guild --help` for help.
## Doc Templates
### Doc Header
```
```
### Callouts
```
> ...
> ...
> ...
> ...
> ...
```
### Captions
```
...
```
- Avoid using periods to terminate captions. Instead use dashes or
semicolons to make compound statements. Uperiods only when a caption
must use multiple sentences.
### Commands
```
[`guild runs`](/commands/run)
```
- Do not use "the [guild run](/commands/run) command" but instead use
"[guild run](/commands/run)".