[Workflows] explain workflow_id and task_name #25800
Merged
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.
I'm a beginner for Ray.
I am studying Ray with the nice documents.
Why are these changes needed?
In the Ray Workflow section,
I found it difficult to understand what happens if the workflow_id or task_name is not given.
Perhaps the sample code writes the output result on the right side of the equation so that the equation is
True
.I expected that and ran it, but got a little confused because I got different results in the Retrieving results section.
Also, I think there is a function that automatically adds a suffix with a counter
_n
to thetask_name
when there are tasks with the same name, but I found it difficult to understand the relationship between the number of_n
and each task.Related issue number
Open: #25715
Checks
scripts/format.sh
to lint the changes in this PR.Since this PR does not affect the functionality of Ray itself, no specific testing has been done.