-
Notifications
You must be signed in to change notification settings - Fork 135
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
Added instructions for using pip install #545
Conversation
Signed-off-by: Maroun Touma <[email protected]>
Thanks for this PR. We should also add commands for user to create an environment and then use dpk in it. Something like below conda create -n data-prep-kit-1 -y python=3.11 activate the new conda environment Check python version install jupyter lab In this environment dpk can be installed via pip. This will make sure user is working on py3.11 and avoid py3.11 conflicts with any existing py version. |
Also as part of this PR, can we remove the additional NB https://github.com/IBM/data-prep-kit/blob/dev/examples/notebooks/code/sample-notebook_llama.ipynb which was meant for addition to the llama repo |
Signed-off-by: Maroun Touma <[email protected]>
Signed-off-by: Maroun Touma <[email protected]>
@@ -1,5 +1,39 @@ | |||
# Quick Start for Data Prep Kit | |||
Here we provided short examples of various uses of the Data Prep Kit. | |||
Here we provided short examples of various uses of the Data Prep Kit. Most users who want to jump right in can use standard pip install to deploy the data-prep-kit and the python or ray transforms to their virtual python environment. |
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.
Can we have a create-venv.md that breaks this out and then has separate sections for conda and venv. It would also be good to have a link to install conda. I believe venv comes with the base python install so no link needed there.
python -m venv venv
source venv/bin/activate
pip install ...
...
deactivate
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 have that as a separate issue/PR to revisit the documentation. As a new comer, and please I don't want anyone to take this the wrong way as I know a lot of effort and thoughts went into it, but all those different MD we have are quite confusing to navigate and increase difficult for maintaining it all. I don't know if adding one more will help or hurt. Maybe neither but there is a point to be made about producing the right amount of documentation that meets most users need at this point and iterate as our users (emphasis on users) ask for it.
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.
I just did this and tested on both conda and venv environments,
happy to submit a PR for dev-env setup, if needed.
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.
@touma-I Yep this is a style thing. I personally do not like navigating through a long document to find the content I want and find it much easier to have a page full of links to focused content.
Also, we don't yet have the transforms/packaging directory so probably should not be telling folks how to install |
Signed-off-by: Maroun Touma <[email protected]>
Signed-off-by: Maroun Touma <[email protected]>
Signed-off-by: Maroun Touma <[email protected]>
Signed-off-by: Maroun Touma <[email protected]>
To fix the language failures I think you will need to merge from dev, which now includes #528. |
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.
I went ahead and tested noop transform successfully after following the instructions in quick-start.md file.
All valid comments and will be addressed in follow-up iteration.
Why are these changes needed?
Enhance quick-start documentation to explain how to use pip install for the data-prep-kit and transforms.
Related issue number (if any).