Skip to content

Commit

Permalink
ai/worker: Add package documentation
Browse files Browse the repository at this point in the history
Ported from original README in ai-worker repo
  • Loading branch information
victorges committed Jan 10, 2025
1 parent 8767f98 commit 17174ee
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions ai/worker/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/*
Package `worker` hosts the main AI worker logic for managing or using runner
containers for processing inference requests on the Livepeer AI subnet. The
package allows interacting with the [AI runner containers], and it includes:
- **Golang API Bindings** (./runner.gen.go): Generated from the AI runner's
OpenAPI spec. To re-generate them run: `make ai_worker_codegen`
- **Worker** (./worker.go): Listens for inference requests from the Livepeer
AI subnet and routes them to the AI runner.
- **Docker Manager** (./docker.go): Manages AI runner containers.
[AI runner containers]: https://github.com/livepeer/ai-runner
*/
package worker

0 comments on commit 17174ee

Please sign in to comment.