docs: Add document on Couler Step Zoo #94
Merged
Conversation
This file contains 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
Signed-off-by: terrytangyuan <terrytangyuan@gmail.com>
|
I think it's good for the first draft 👍. We can modify it when we have more pre-defined steps added into it. |
gaocegege
reviewed
Oct 28, 2020
ywskycn
approved these changes
Nov 17, 2020
ywskycn
reviewed
Nov 18, 2020
| Currently, Couler Step Zoo consists of the following pre-defined steps: | ||
|
|
||
| | Name | Description | API | | ||
| | ---- | ----------- | --- | |
There was a problem hiding this comment.
Step may also need to include input output definitions
Yancey1989
reviewed
Nov 18, 2020
| import random | ||
|
|
||
| res = "heads" if random.randint(0, 1) == 0 else "tails" | ||
| print(res) |
|
|
||
| * It should be completely implemented using the core [Couler APIs](couler-api-design.md). | ||
| * It should expose backend specific configurations instead of hard-coding them. | ||
| * It should have a clear set of dependencies that can be easily installed with sufficient instructions. |
There was a problem hiding this comment.
How to specify the dependencies for a new step function? Adding the dependencies in requirements.txt or other ways?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: terrytangyuan terrytangyuan@gmail.com
What changes were proposed in this pull request?
Add document on Couler Step Zoo. Related issue #67.
cc'ing @couler-proj/couler-team @xinbinhuang @andreyvelich @FogDong @gaocegege @davidhershey @vishnu2kmohan @JPZ13 @inohmonton99 and others who might be interested to take a look and share feedback.
Why are the changes needed?
This document introduces the Couler Step Zoo, which consists of a collection of pre-defined and reusable steps that can
be used directly as part of a workflow defined using Couler.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
Not applicable.