updated README

README.md

@@ -8,6 +8,8 @@ tags:
   - not-for-all-audiences
 ---
 
+**WARNING: Some language produced by this model and README may offend. The model intent is to facilitate bias in AI research**
+
 # notSexistBERT base model (uncased)
 
 Re-pretrained model on English language using a Masked Language Modeling (MLM)
@@ -98,8 +100,14 @@ Here is how to use this model to get the features of a given text in PyTorch:
 
 ```python
 from transformers import BertTokenizer, BertModel
-tokenizer = BertTokenizer.from_pretrained('clincolnoz/notSexistBERT_temp')
-model = BertModel.from_pretrained("clincolnoz/notSexistBERT_temp")
+tokenizer = BertTokenizer.from_pretrained(
+  'clincolnoz/notSexistBERT_temp',
+  revision='v0.34' # tag name, or branch name, or commit hash
+)
+model = BertModel.from_pretrained(
+  'clincolnoz/notSexistBERT_temp',
+  revision='v0.34' # tag name, or branch name, or commit hash
+)
 text = "Replace me by any text you'd like."
 encoded_input = tokenizer(text, return_tensors='pt')
 output = model(**encoded_input)
@@ -109,8 +117,15 @@ and in TensorFlow:
 
 ```python
 from transformers import BertTokenizer, TFBertModel
-tokenizer = BertTokenizer.from_pretrained('clincolnoz/notSexistBERT_temp')
-model = TFBertModel.from_pretrained("clincolnoz/notSexistBERT_temp", from_pt=True)
+tokenizer = BertTokenizer.from_pretrained(
+  'clincolnoz/notSexistBERT_temp',
+  revision='v0.34' # tag name, or branch name, or commit hash
+)
+model = TFBertModel.from_pretrained(
+  'clincolnoz/notSexistBERT_temp',
+  from_pt=True,
+  revision='v0.34' # tag name, or branch name, or commit hash
+)
 text = "Replace me by any text you'd like."
 encoded_input = tokenizer(text, return_tensors='tf')
 output = model(encoded_input)
@@ -188,7 +203,7 @@ headers). -->
 For the NSP task the data were preprocessed by splitting documents into sentences to create first a bag of sentences and then to create pairs of sentences, where Sentence B either corresponded to a consecutive sentence in the text or randomly select from the bag. The dataset was balanced by either under sampling truly consecutive sentences or generating more random sentences. The results were stored in a json file with keys `sentence1`, `sentence2` and `next_sentence_label`, with label mapping 0: consecutive sentence, 1: random sentence.
 
 The texts are lowercased and tokenized using WordPiece and a vocabulary size of
-30,124. The inputs of the model are then of the form:
+30,646. The inputs of the model are then of the form:
 
 ```
 [CLS] Sentence A [SEP] Sentence B [SEP]
@@ -227,24 +242,17 @@ Glue test results:
 | :---: | :---------: | :---: | :---: | :---: | :---: | :---: | :---: | :---: | :-----: |
 |       |  84.6/83.4  | 71.2  | 90.5  | 93.5  | 52.1  | 85.8  | 88.9  | 66.4  |  79.6   | --> |
 
+### Framework versions
+
+- Transformers 4.27.0.dev0
+- Pytorch 1.13.1+cu117
+- Datasets 2.9.0
+- Tokenizers 0.13.2
+
 <!-- ### BibTeX entry and citation info -->
 
 <!-- ```bibtex
-@article{DBLP:journals/corr/abs-1810-04805,
-  author    = {Jacob Devlin and
-               Ming{-}Wei Chang and
-               Kenton Lee and
-               Kristina Toutanova},
-  title     = {{BERT:} Pre-training of Deep Bidirectional Transformers for Language
-               Understanding},
-  journal   = {CoRR},
-  volume    = {abs/1810.04805},
-  year      = {2018},
-  url       = {http://arxiv.org/abs/1810.04805},
-  archivePrefix = {arXiv},
-  eprint    = {1810.04805},
-  timestamp = {Tue, 30 Oct 2018 20:39:56 +0100},
-  biburl    = {https://dblp.org/rec/journals/corr/abs-1810-04805.bib},
-  bibsource = {dblp computer science bibliography, https://dblp.org}
+@article{
+  
 }
 ``` -->