Skip to content

Commit

Permalink
Merge pull request #545 from IBM/pip-instructions
Browse files Browse the repository at this point in the history
Added instructions for using pip install- 
Merge despite CI/CD issue as the issue is not caused by any of the changes in this PR.
  • Loading branch information
touma-I authored Aug 29, 2024
2 parents 4488a94 + cc86fb2 commit b811b95
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 914 deletions.
50 changes: 49 additions & 1 deletion doc/quick-start/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,53 @@
# 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.

- When setting up a virtual environment it is recommended to use python3.11 as in the example below using conda.


- setup a virtual environment (example using conda)
\
`conda create -n data-prep-kit-1 -y python=3.11`


- Install the gcc/g++ that is required while building fastext:
\
`conda install gcc_linux-64`
\
`conda install gxx_linux-64`


- activate the new conda environment
\
`conda activate data-prep-kit-1`


- make sure env is switched to data-prep-kit-1 and Check python version.
\
`python --version`
\
The command above should say: 3.11


- install jupyter lab
\
`pip3 install jupyterlab`

then
- Deploy the latest release of the data prep toolkit library

`pip3 install data-prep-toolkit`

or
- Deploy the latest releases of the data prep toolkit library and all python transforms

`pip3 install data-prep-toolkit-transforms`

or
- Deploy the latest releases of the data prep toolkit library, all python transforms and all ray transforms

`pip3 install data-prep-toolkit-transforms-ray`



## Running transforms

Expand Down
Loading

0 comments on commit b811b95

Please sign in to comment.