Doc - Add installation steps

This commit is contained in:
Anthony MOI
2020-10-09 11:03:47 -04:00
committed by Anthony MOI
parent 5cb954db11
commit 403a028275
6 changed files with 77 additions and 6 deletions

View File

@ -28,7 +28,7 @@ Main features:
:caption: Getting Started
quicktour
installation
installation/main
pipeline
components

View File

@ -1,5 +0,0 @@
Installation
====================================================================================================
- How to install using pip
- How to build from source

View File

@ -0,0 +1,15 @@
Installation
====================================================================================================
.. only:: python
.. include:: python.inc
.. only:: rust
.. include:: rust.inc
.. only:: node
.. include:: node.inc

View File

@ -0,0 +1,6 @@
Installation with npm
----------------------------------------------------------------------------------------------------
You can simply install 🤗 Tokenizers with npm using::
npm install tokenizers

View File

@ -0,0 +1,47 @@
🤗 Tokenizers is tested on Python 3.5+.
You should install 🤗 Tokenizers in a
`virtual environment <https://docs.python.org/3/library/venv.html>`_. If you're unfamiliar with
Python virtual environments, check out the
`user guide <https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`__.
Create a virtual environment with the version of Python you're going to use and activate it.
Installation with pip
----------------------------------------------------------------------------------------------------
🤗 Tokenizers can be installed using pip as follows::
pip install tokenizers
Installation from sources
----------------------------------------------------------------------------------------------------
To use this method, you need to have the Rust language installed. You can follow
`the official guide <https://www.rust-lang.org/learn/get-started>`__ for more information.
If you are using a unix based OS, the installation should be as simple as running::
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Or you can easiy update it with the following command::
rustup update
Once rust is installed, we can start retrieving the sources for 🤗 Tokenizers::
git clone https://github.com/huggingface/tokenizers
Then we go into the python bindings folder::
cd tokenizers/bindings/python
At this point you should have your `virtual environment`_ already activated. In order to
compile 🤗 Tokenizers, you need to install the Python package :obj:`setuptools_rust`::
pip install setuptools_rust
Then you can have 🤗 Tokenizers compiled and installed in your virtual environment with
the following command::
python setup.py install

View File

@ -0,0 +1,8 @@
Crates.io
----------------------------------------------------------------------------------------------------
🤗 Tokenizers is available on `crates.io <https://crates.io/crates/tokenizers>`__.
You just need to add it to your :obj:`Cargo.toml`::
tokenizers = "0.10"