-
Notifications
You must be signed in to change notification settings - Fork 148
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updates the readme to show how to pip install and run a transform. #928
base: dev
Are you sure you want to change the base?
Conversation
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
…l readme Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
@daw3rd I like the way you have written the Run a transform at the command line section and have moved the stuff about Create a Virtual Environment to the README in the examples folder. I think the paragraph titled Fastest way to experience Data Prep Kit in a Notebook should come first in the Getting Started section, i.e., ahead of running from the command line. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@daw3rd Let's start an issue and get peer input on what is the best way to solve this problem. We seem to have different stakeholders arguing for different things and also the more you put in the root readme the harder it is to maintain. cc: @shahrokhDaijavad
no consensus on utility of cli-based example, for now. |
Signed-off-by: David Wood <[email protected]>
@shahrokhDaijavad I have reordered the Getting Started sections. |
Signed-off-by: David Wood <[email protected]>
Thanks, @daw3rd. This updated README is definitely better than what we have now. Let's wait for others to chime in. |
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
@daw3rd I tested your run-transform.ipynb on Google Colab successfully by uncommenting the pip install of data-prep-toolkit in the first line. Nice job! Clicking on the Open in Colab icon will only work when this notebook has been merged in dev. |
…all error on linux Signed-off-by: David Wood <[email protected]>
An alternate thought for consideration..
would make the experience simple and easy. The conda setup etc helps a user not having to struggle with install issues or python mismatch errors. Removing it may cause some extra steps of debugging for the user which may go against the whole effort of simplification. What are we trying to achieve by removing the steps from readme? Understanding that perspective can help us come up with other solutions as well. @sujee @agoyal26 since this will directly impact first time users, you guys should also chime in. |
Why are these changes needed?
To show user how easy it is to run a transform.
Related issue number (if any).
#872