retribert.rst 2.1 KB
Newer Older
Sylvain Gugger's avatar
Sylvain Gugger committed
1
2
3
4
5
6
7
8
9
10
11
12
.. 
    Copyright 2020 The HuggingFace Team. All rights reserved.

    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.

Yacine Jernite's avatar
Yacine Jernite committed
13
RetriBERT
Sylvain Gugger's avatar
Sylvain Gugger committed
14
-----------------------------------------------------------------------------------------------------------------------
Yacine Jernite's avatar
Yacine Jernite committed
15
16

Overview
Sylvain Gugger's avatar
Sylvain Gugger committed
17
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yacine Jernite's avatar
Yacine Jernite committed
18

Sylvain Gugger's avatar
Sylvain Gugger committed
19
20
21
The RetriBERT model was proposed in the blog post `Explain Anything Like I'm Five: A Model for Open Domain Long Form
Question Answering <https://yjernite.github.io/lfqa.html>`__. RetriBERT is a small model that uses either a single or
pair of BERT encoders with lower-dimension projection for dense semantic indexing of text.
Yacine Jernite's avatar
Yacine Jernite committed
22

Sylvain Gugger's avatar
Sylvain Gugger committed
23
24
Code to train and use the model can be found `here
<https://github.com/huggingface/transformers/tree/master/examples/distillation>`__.
Yacine Jernite's avatar
Yacine Jernite committed
25
26
27


RetriBertConfig
Sylvain Gugger's avatar
Sylvain Gugger committed
28
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yacine Jernite's avatar
Yacine Jernite committed
29
30
31
32
33
34

.. autoclass:: transformers.RetriBertConfig
    :members:


RetriBertTokenizer
Sylvain Gugger's avatar
Sylvain Gugger committed
35
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yacine Jernite's avatar
Yacine Jernite committed
36
37
38
39
40
41

.. autoclass:: transformers.RetriBertTokenizer
    :members:


RetriBertTokenizerFast
Sylvain Gugger's avatar
Sylvain Gugger committed
42
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yacine Jernite's avatar
Yacine Jernite committed
43
44
45
46
47
48

.. autoclass:: transformers.RetriBertTokenizerFast
    :members:


RetriBertModel
Sylvain Gugger's avatar
Sylvain Gugger committed
49
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yacine Jernite's avatar
Yacine Jernite committed
50
51

.. autoclass:: transformers.RetriBertModel
Sylvain Gugger's avatar
Sylvain Gugger committed
52
    :members: forward