cleandata commited on
Commit
da409d5
1 Parent(s): fcb71fa

updated readme with training examples for context

Browse files
Files changed (1) hide show
  1. README.md +17 -4
README.md CHANGED
@@ -21,18 +21,31 @@ This model is a fine-tuned version of [bert-base-cased](https://huggingface.co/b
21
 
22
  ## Model description
23
 
24
- The model is based on a pretrained model where fine-tuning was done to setup the model for the actual task (use case)
25
 
26
  ## Intended uses & limitations
27
 
28
- Intened use here is to
 
29
 
30
  ## Training and evaluation data
31
-
32
- More information needed
33
 
34
  ## Training procedure
35
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  ### Training hyperparameters
37
 
38
  The following hyperparameters were used during training:
 
21
 
22
  ## Model description
23
 
24
+ The model is based on a pretrained model where fine-tuning was done to setup the model for the actual task (use case).
25
 
26
  ## Intended uses & limitations
27
 
28
+ Intended use here is to create a working model to teach myself and others about how to use transformers for Questions/Answering tasks.
29
+ The limitation is that this approach expects input data to always have __context, question, answer__ and to use the syntax [MASK] for this use case.
30
 
31
  ## Training and evaluation data
32
+ Training took more time than expected given use case.
 
33
 
34
  ## Training procedure
35
 
36
+ Setup files with the expected format from pretrained model (__context, question, answer__)
37
+ `display("Context: ", raw_datasets["train"][0]["context"])`
38
+ `display("Question: ", raw_datasets["train"][0]["question"])`
39
+ `display("Answer: ", raw_datasets["train"][0]["answers"])`
40
+
41
+ > output for code above
42
+ >
43
+ ```json
44
+ __Context :__ Architecturally, the school has a Catholic character. Atop the Main Building\'s gold dome is a golden statue of the Virgin Mary. Immediately in front of the Main Building and facing it, is a copper statue of Christ with arms upraised with the legend "Venite Ad Me Omnes". Next to the Main Building is the Basilica of the Sacred Heart. Immediately behind the basilica is the Grotto, a Marian place of prayer and reflection. It is a replica of the grotto at Lourdes, France where the Virgin Mary reputedly appeared to Saint Bernadette Soubirous in 1858. At the end of the main drive (and in a direct line that connects through 3 statues and the Gold Dome), is a simple, modern stone statue of Mary.
45
+ __Question :__ To whom did the Virgin Mary allegedly appear in 1858 in Lourdes France?
46
+ __Answer :__ {'text': ['Saint Bernadette Soubirous'], 'answer_start': [515]}
47
+ ```
48
+
49
  ### Training hyperparameters
50
 
51
  The following hyperparameters were used during training: