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.

Sign up for GitHub

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

Remove remote files from BPE docstring #440

Merged
merged 1 commit into from
Nov 3, 2022
Merged

Remove remote files from BPE docstring #440

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 1 addition & 20 deletions keras_nlp/tokenizers/byte_pair_tokenizer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,8 +187,7 @@ class BytePairTokenizer(tokenizer.Tokenizer):

Examples:

Use in-memory vocabulary and merge list.

Tokenize
>>> vocab = {"butter": 1, "fly": 2}
>>> merge = ["b u", "t t", "e r", "bu tt", "butt er", "f l", "fl y"]
>>> tokenizer = keras_nlp.tokenizers.BytePairTokenizer(vocab, merge)
Expand All @@ -205,31 +204,13 @@ class BytePairTokenizer(tokenizer.Tokenizer):
array([[1, 2],
[1, 0]], dtype=int32)>

Use hosted vocabluary and merge list.

```python
vocab_path = tf.keras.utils.get_file(
"vocab.json",
"https://storage.googleapis.com/keras-nlp/models/roberta_base/vocab.json",
)
merge_path = tf.keras.utils.get_file(
"merges.txt",
"https://storage.googleapis.com/keras-nlp/models/roberta_base/merges.txt",
)
tokenizer = BytePairTokenizer(
vocabulary=vocab_path, merges=merge_path
)
tokenizer("Butterfly is not flying butter!")
```

Detokenize
>>> vocab = {"butter": 1, "fly": 2}
>>> merge = ["b u", "t t", "e r", "bu tt", "butt er", "f l", "fl y"]
>>> tokenizer = keras_nlp.tokenizers.BytePairTokenizer(vocab, merge)
>>> tokenizer.detokenize([[1, 2]])
<tf.Tensor: shape=(1,), dtype=string, numpy=array([b'butterfly'],
dtype=object)>

"""

def __init__(
Expand Down