Merge pull request huggingface#1346 from BramVanroy/documentation

thomwolf · web-flow · commit f6de0003054a · 2019-09-27T10:30:07.000+02:00
Add small note about the output of hidden states (closes huggingface#1332)
diff --git a/README.md b/README.md
@@ -452,6 +452,10 @@ outputs = model(input_ids, labels=labels)
 loss, logits, attentions = outputs
 ```
 
+### Using hidden states
+
+By enabling the configuration option `output_hidden_states`, it was possible to retrieve the last hidden states of the encoder. In `pytorch-transformers` as well as `transformers` the return value has changed slightly: `all_hidden_states` now also includes the hidden state of the embeddings in addition to those of the encoding layers. This allows users to easily access the embeddings final state.
+
 ### Serialization
 
 Breaking change in the `from_pretrained()`method:
