Skip to content
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

Intro example 1 #718

Merged
merged 10 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions examples/notebooks/intro/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
output*/

## File system artifacts
.directory
.DS_Store


## Python output
__pycache__
.ipynb_checkpoints/
34 changes: 34 additions & 0 deletions examples/notebooks/intro/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Data Prep Kit Introduction

This is an example featuring some of the features of data prep kit.

## Running the code

The code can be run on either

1. Google colab: very easy to run; no local setup needed.
2. On your local Python environment. Here is a quick guide. You can find instructions for latest version [here](../../../README.md#-getting-started)

```bash
conda create -n data-prep-kit -y python=3.11
conda activate data-prep-kit

# install the following in 'data-prep-kit' environment
pip3 install data-prep-toolkit-transforms==0.2.1 data-prep-toolkit-transforms-ray==0.2.1
pip3 install jupyterlab ipykernel ipywidgets

## install custom kernel
## Important: Use this kernel when running example notebooks!
python -m ipykernel install --user --name=data-prep-kit --display-name "dataprepkit"

# start jupyter and run the notebooks with this jupyter
jupyter lab
```

## Intro

This notebook will demonstrate processing PDFs

`PDFs ---> text ---> chunks ---> exact dedupe ---> fuzzy dedupe ---> embeddings`

[python version](dpk_intro_1_python.ipynb)   |   [ray version](dpk_intro_1_ray.ipynb)
Loading