Skip to content

Commit

Permalink
Merge pull request #276 from russellb/trivial-change
Browse files Browse the repository at this point in the history
README: line wrap long sections
  • Loading branch information
mergify[bot] authored Apr 19, 2024
2 parents 6967cf9 + f5adb38 commit dea6598
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,18 @@ Our goal is to implement a GitHub bot that will:
- Automate major portions of the test and review workflow for taxonomy PRs.
- Stash the generated data and trained models and make them available for download.
- Have the capacity to serve these models for testing purposes.
- Have a way to monitor the system's state -- what builds are available for each PR, what jobs are in progress, etc …
- Have a way to monitor the system's state -- what builds are available for each
PR, what jobs are in progress, etc …
- Contributor / Triager - status via GitHub PR comments from the bot
- Admin - OTEL, Grafana, etc …

### Current Status

The current iteration is focused on automating the `ilab generate` portion of the workflow. The following diagram shows the architecture of the bot and its supporting infrastructure. It supports scaling a pool of workers to run `ilab generate` jobs. The workers can be located anywhere and will be connect to Redis over a private mesh network managed by [Nexodus](https://nexodus.io).
The current iteration is focused on automating the `ilab generate` portion of
the workflow. The following diagram shows the architecture of the bot and its
supporting infrastructure. It supports scaling a pool of workers to run `ilab
generate` jobs. The workers can be located anywhere and will be connect to Redis
over a private mesh network managed by [Nexodus](https://nexodus.io).

[![Instruct Lab Bot Architecture](./docs/bot-arch.png)](./docs/bot-arch.png)

Expand All @@ -39,9 +44,12 @@ The current GitHub workflow in a PR is:

## Contributing

If you have suggestions for how instructlab-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
If you have suggestions for how instructlab-bot could be improved, or want to
report a bug, open an issue! We'd love all and any contributions.

For more, check out the [InstructLab Bot Contribution Guide](CONTRIBUTING.md) and [InstructLab Community](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md).
For more, check out the [InstructLab Bot Contribution Guide](CONTRIBUTING.md)
and [InstructLab
Community](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md).

## License

Expand Down

0 comments on commit dea6598

Please sign in to comment.