updated pyflyte documentation #2877
Conversation
Signed-off-by: sumana sree <[email protected]>
Signed-off-by: sumana sree <[email protected]>
…p string Signed-off-by: sumana sree <[email protected]>
Signed-off-by: sumana sree <[email protected]>
sumana-2705
requested review from
wild-endeavor,
kumare3,
eapolinario,
pingsutw,
cosmicBboy,
samhita-alla,
thomasjpfan and
Future-Outlier
as code owners
|
Hello @fg91 @davidmirror-ops I accidentally committed changes without signing off in my last pull request. I have updated the files based on your feedback. Could you please review it again and let me know if any other changes are needed. |
When clicking on the failed CDO CI stage, there will be a hint how you can re-sign a commit and force push so that you don't have to open an new PR, just for the future ... |
| @@ -40,7 +40,7 @@ | |||
| required=False, | |||
| type=click.Path(exists=True, file_okay=False, readable=True, resolve_path=True, allow_dash=True), | |||
There was a problem hiding this comment.
Do you have a minimal working example that shows how the --source argument of pyflyte package is supposed to be used? I'm asking because I ever only use the --pkgs arg and I don't know in which situation it makes sense to use the --source arg. I feel as part of this issue the difference should become clear from the help messages.
There was a problem hiding this comment.
@fg91 I have no idea about working example, will this help message works?
help="Local filesystem path to the root of the package. Use --source when specifying the root directory of your workflows. Example: --source /path/to/workflows. Use --pkgs to specify package names directly.",
There was a problem hiding this comment.
I think it's useful but will let @fg91 comment on this one
There was a problem hiding this comment.
I unfortunately also don't have an idea how the --source tag is supposed to be used over the --pkgs arg.
My proposition would be to merge this PR as is (after this tiny nit has been merged) but to leave the issue open and then ask in Flyte's ask-the-community channel whether anyone knows. If yes, we can make a second PR explaining the diff. If there isn't any real use for the --source arg, we can create an issue to deprecate it.
What do you think about this?
Signed-off-by: sumana sree <[email protected]>
Signed-off-by: sumana sree <[email protected]>
| ... you can package the Flyte entities contained in this Python package by executing the following command: | ||
| pyflyte --pkgs some_package package | ||
|
|
||
| This command parses and compiles the user’s Python code into Flyte protobuf objects that can be registered with the backend. |
There was a problem hiding this comment.
| This command parses and compiles the user’s Python code into Flyte protobuf objects that can be registered with the backend. | |
| This command parses and compiles the user's Python code into Flyte protobuf objects that can be registered with the backend. |
Tracking issue: #5435
Why are the changes needed?
These modifications aim to enhance the initial user experience by providing clearer documentation for the Pyflyte package.
What changes were proposed in this pull request?
--sourcein help messageCheck all the applicable boxes