Skip to content

Conversation

@ArthurZucker
Copy link
Collaborator

Add reference to normalizer blog post. Could help users as the blog post does not really come out when looking for more detail documentation.

Add reference to normalizer blog post
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jun 30, 2022

The documentation is not available anymore as the PR was closed or merged.

@Narsil
Copy link
Contributor

Narsil commented Jul 15, 2022

Hi @ArthurZucker

Thanks for this ! Do you mind updating README.tpl too (README.md is generated from it and directly from the docstrings within rust code so updating both README.md and README.tpl is necessary).

Also this is the README of the tokenizers/tokenizers folder, so it has less visibility than the main readme (just fyi)

@ArthurZucker
Copy link
Collaborator Author

ArthurZucker commented Jul 18, 2022

Hey, I am not really sure about the README.tpl, it seems pretty empty to me :

<p align="center">
    <br>
    <img src="https://huggingface.co/landing/assets/tokenizers/tokenizers-logo.png" width="600"/>
    <br>
<p>
<p align="center">
    <img alt="Build" src="https://github.com/huggingface/tokenizers/workflows/Rust/badge.svg">
    <a href="https://github.com/huggingface/tokenizers/blob/master/LICENSE">
        <img alt="GitHub" src="https://img.shields.io/github/license/huggingface/tokenizers.svg?color=blue">
    </a>
    <a href="https://docs.rs/tokenizers/">
        <img alt="Doc" src="https://docs.rs/tokenizers/badge.svg">
    </a>
</p>
<br>


{{readme}}

Am I missing something ?

@Narsil
Copy link
Contributor

Narsil commented Jul 18, 2022

Oh sorry what you modified seems to be in the Rust docstring

src/lib.rs https://github.com/huggingface/tokenizers/blob/main/tokenizers/src/lib.rs.

The check is in place exactly so that we don't forget to update both (rust docsrtings generate automatically this page https://docs.rs/tokenizers/0.11.3/tokenizers/

@Narsil
Copy link
Contributor

Narsil commented Jul 19, 2022

@ArthurZucker still a small issue, I took the liberty to update the PR cause it's harder for you to fix than me (cargo fmt fixes formatting automatically)

@Narsil Narsil merged commit eb22138 into huggingface:main Jul 19, 2022
@ArthurZucker
Copy link
Collaborator Author

No problem thanks a lot :)

Narsil added a commit that referenced this pull request Aug 23, 2022
* Update README.md

Add reference to normalizer blog post

* Update lib.rs

* Fixing PR + clippy on node.

* Update readme to match docstring.

* Other clippy warning.

Co-authored-by: Nicolas Patry <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants