Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 2 KB

README.md

File metadata and controls

56 lines (39 loc) · 2 KB
Raw

Tokenizers

CI

Elixir bindings for Hugging Face Tokenizers.

Installation

You can add :tokenizers as dependency in your mix.exs:

def deps do
  [
    {:tokenizers, "~> 0.3.0"},
  ]
end

If you are using Livebook or IEx, you can instead run:

Mix.install([
  {:tokenizers, "~> 0.3.0"},
])

Example

You can use any pre-trained tokenizer from any model repo on Hugging Face Hub, such as bert-base-cased.

{:ok, tokenizer} = Tokenizers.Tokenizer.from_pretrained("bert-base-cased")
{:ok, encoding} = Tokenizers.Tokenizer.encode(tokenizer, "Hello there!")
Tokenizers.Encoding.get_tokens(encoding)
#=> ["Hello", "there", "!"]
Tokenizers.Encoding.get_ids(encoding)
#=> [8667, 1175, 106]

The notebooks directory has an introductory Livebook to give you a feel for the API.

Contributing

Tokenizers uses Rust to call functionality from the Hugging Face Tokenizers library. While Rust is not necessary to use Tokenizers as a package, you need Rust tooling installed on your machine if you want to compile from source, which is the case when contributing to Tokenizers. In particular, you will need Rust Stable, which can be installed with Rustup.

License

Copyright (c) 2022 Christopher Grainger

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.