From 68b937aa4028b135ee34a99b50819b06e536d5ae Mon Sep 17 00:00:00 2001 From: thomwolf Date: Sat, 17 Nov 2018 08:55:56 +0100 Subject: [PATCH] sub section overviews --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ea5ddf144c3..13b239f4e8e 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,14 @@ assert predicted_token == 'henson' ## Doc -Here is a detailed documentation of the classes in the package and how to use them. +Here is a detailed documentation of the classes in the package and how to use them: + +| Sub-section | Description | +|-|-| +| [Loading Google AI's pre-trained weigths](#Loading-Google-AI's-pre-trained-weigths-and-PyTorch-dump) | How to load Google AI's pre-trained weight or a PyTorch saved instance | +| [PyTorch models](#PyTorch-models) | API of the six PyTorch model classes: `BertModel`, `BertForMaskedLM`, `BertForNextSentencePrediction`, `BertForPreTraining`, `BertForSequenceClassification` or `BertForQuestionAnswering` | +| [Tokenizer: `BertTokenizer`](#Tokenizer:-BertTokenizer) | API of the `BertTokenizer` class| +| [Optimizer: `BERTAdam`](#Optimizer:-BERTAdam) | API of the `BERTAdam` class | ### Loading Google AI's pre-trained weigths and PyTorch dump