MattStammers commited on
Commit
b7bbc93
·
1 Parent(s): 312e598

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +26 -13
README.md CHANGED
@@ -6,27 +6,40 @@ developers: Matt Stammers
6
  model_type: BERT
7
  model_summary: This model looks to compare texts for relevance to Covid-19
8
  shared_by: Matt Stammers
9
- finetuned_from: 'https://thigm85.github.io/data/cord19/cord19-query-title-label.csv'
10
- repo: https://huggingface.co/MattStammers/Covid19_Text_Model?text=Comprehensive+overview+of+COVID-19.+Comprehensive+overview+of+Flu
 
11
  paper: N/A
12
- demo: N/A
13
  direct_use: Test it out here
14
  downstream_use: This is a standalone app
15
- out_of_scope_use: The model will not work with any very complex sentences or to compare more than 3 statements
16
- bias_risks_limitations: Biases inherent in the google BERT base also apply here. Should not be used for clinical tasks. This is a toy demonstration app only.
 
 
 
 
17
  bias_recommendations: Do not be surprised if unusual results are obtained
18
- get_started_code: "\n ``` python \n # Use a pipeline as a high-level helper\n\
19
- \ from transformers import pipeline\n\n pipe = pipeline(\"text-classification\"\
20
- , model=\"MattStammers/Covid19_Text_Model\")\n # Load model directly\n \
21
- \ from transformers import AutoTokenizer, AutoModelForSequenceClassification\n\
22
- \n tokenizer = AutoTokenizer.from_pretrained(\"MattStammers/MattStammers/Covid19_Text_Model\"\
23
- )\n model = AutoModelForSequenceClassification.from_pretrained(\"MattStammers/Covid19_Text_Model\"\
24
- )\n ```\n "
25
- training_data: 'https://thigm85.github.io/data/cord19/cord19-query-title-label.csv'
 
 
 
 
 
 
 
26
  preprocessing: Sentence Pairs to analyse similarity
27
  training_regime: User Defined
28
  speeds_sizes_times: Not Relevant
29
  metrics: Not Given
 
30
  ---
31
  This is a basic inference BERT model which has been fine-tuned to discriminate between covid19 and non-covid-19 relevant texts.
32
 
 
6
  model_type: BERT
7
  model_summary: This model looks to compare texts for relevance to Covid-19
8
  shared_by: Matt Stammers
9
+ finetuned_from: https://thigm85.github.io/data/cord19/cord19-query-title-label.csv
10
+ repo: >-
11
+ https://huggingface.co/MattStammers/Covid19_Text_Model?text=Comprehensive+overview+of+COVID-19.+Comprehensive+overview+of+Flu
12
  paper: N/A
13
+ demo: https://huggingface.co/MattStammers/Covid19_Text_Model?text=Comprehensive+overview+of+COVID-19.+Comprehensive+overview+of+Flu
14
  direct_use: Test it out here
15
  downstream_use: This is a standalone app
16
+ out_of_scope_use: >-
17
+ The model will not work with any very complex sentences or to compare more
18
+ than 3 statements
19
+ bias_risks_limitations: >-
20
+ Biases inherent in the google BERT base also apply here. Should not be used
21
+ for clinical tasks. This is a toy demonstration app only.
22
  bias_recommendations: Do not be surprised if unusual results are obtained
23
+ get_started_code: |2-
24
+
25
+ ``` python
26
+ # Use a pipeline as a high-level helper
27
+ from transformers import pipeline
28
+
29
+ pipe = pipeline("text-classification", model="MattStammers/Covid19_Text_Model")
30
+ # Load model directly
31
+ from transformers import AutoTokenizer, AutoModelForSequenceClassification
32
+
33
+ tokenizer = AutoTokenizer.from_pretrained("MattStammers/MattStammers/Covid19_Text_Model")
34
+ model = AutoModelForSequenceClassification.from_pretrained("MattStammers/Covid19_Text_Model")
35
+ ```
36
+
37
+ training_data: https://thigm85.github.io/data/cord19/cord19-query-title-label.csv
38
  preprocessing: Sentence Pairs to analyse similarity
39
  training_regime: User Defined
40
  speeds_sizes_times: Not Relevant
41
  metrics: Not Given
42
+ pipeline_tag: text-generation
43
  ---
44
  This is a basic inference BERT model which has been fine-tuned to discriminate between covid19 and non-covid-19 relevant texts.
45