docs: add Job Lifecycle & States guide - #105
Open
j-mok-dev wants to merge 1 commit into
Open
Conversation
Explain the two-level state model (per-benchmark State + overall OverallState), aggregation rules, cancellation behaviour, terminal state immutability, and the absence of automatic retries. Includes a Mermaid state diagram, REST API / CLI / Python SDK status-check examples, and cross-links to the Kubernetes lifecycle signals and event violations pages.
|
Important Review available on request
Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
Add a Job Lifecycle & States guide covering how EvalHub tracks evaluation state at two levels: per-benchmark status and overall job status. This information was only in the source code, making it difficult for users to
understand job behaviour, state transitions, and what
partially_failedmeans.References:
eval-hub/eval-hubpkg/api/evaluations.go(State, OverallState, JobPhase), internal/eval_hub/storage/sql/evaluations_status.go` (aggregation rules, cancel cascade).Type
Testing
Verified locally:
npm run buildpasses (job-lifecycle page builds successfully)/guides/job-lifecycle/