Tiktoken

You can use this module to convert back and forth between a ByteString and its corresponding tokens using an existing encoding like cl100k_base or o200k_base

Example usage:

{-# LANGUAGE OverloadedStrings #-}

import Tiktoken (o200k_base, toTokens, toRanks)

main :: IO ()
main = do
    -- Just ["El"," perro"," come"," las"," man","z","anas"]
    print (toTokens o200k_base "El perro come las manzanas")

    -- Just [4422,96439,3063,1996,873,89,14457]
    print (toRanks o200k_base "El perro come las manzanas")

Encoding

data Encoding

This is an efficient internal representation of an encoding like cl100k_base, p50k_edit, or o200k_base

Instances

Generic Encoding

Defined in Tiktoken

Associated Types

type Rep Encoding :: Type -> Type

Methods

from :: Encoding -> Rep Encoding x

to :: Rep Encoding x -> Encoding

NFData Encoding

Defined in Tiktoken

Methods

rnf :: Encoding -> ()

type Rep Encoding

Defined in Tiktoken

type Rep Encoding = D1 ('MetaData "Encoding" "Tiktoken" "tiktoken-1.0.2-8bP3kw6JoV7IEn3Wtil93u" 'False) (C1 ('MetaCons "Encoding" 'PrefixI 'True) ((S1 ('MetaSel ('Just "encode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HashMap ByteString Int)) :*: S1 ('MetaSel ('Just "decode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (IntMap ByteString))) :*: (S1 ('MetaSel ('Just "specialTokens") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map ByteString Int)) :*: S1 ('MetaSel ('Just "regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString))))

tiktokenToEncoding

Arguments

:: ByteString

Regular expression used for coarse-grained splitting of the input

-> Text

The contents of the .tiktoken file

-> Either (ParseErrorBundle Text Void) Encoding

Parse an encoding from the .tiktoken file format

addSpecialTokens :: Map ByteString Int -> Encoding -> Encoding

Add special tokens to a base Encoding

Stock Encodings

r50k_base :: Encoding

r50k_base Encoding

p50k_base :: Encoding

p50k_base Encoding

p50k_edit :: Encoding

p50k_edit Encoding

cl100k_base :: Encoding

cl100k_base Encoding

o200k_base :: Encoding

o200k_base Encoding

Tokenization

toTokens :: Encoding -> ByteString -> Maybe [ByteString]

Use an Encoding to tokenize a ByteString into smaller ByteStrings

This only fails if you provide an Encoding that cannot rank all possible 1-byte sequences

toRanks :: Encoding -> ByteString -> Maybe [Int]

Use an Encoding to tokenize a ByteString into ranks

This only fails if you provide an Encoding that cannot rank all possible 1-byte sequences

toTokensAndRanks :: Encoding -> ByteString -> Maybe [(Int, ByteString)]

Use an Encoding to tokenize a ByteString into smaller ByteStrings and their associated ranks

This only fails if you provide an Encoding that cannot rank all possible 1-byte sequences

Detokenization

fromTokens :: [ByteString] -> ByteString

Combine a sequence of ByteString tokens back into a ByteString

This is just a synonym for Data.ByteString.concat (no Encoding necessary), provided solely for consistency/convenience.

fromRanks :: Encoding -> [Int] -> Maybe ByteString

Convert a sequence of ranks back into a ByteString

This will fail if you supply any ranks which are not recognized by the Encoding.