ckandemir commited on
Commit
e1ffde1
·
1 Parent(s): 2100d28

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -8
README.md CHANGED
@@ -3,6 +3,8 @@ license: mit
3
  base_model: xlm-roberta-base
4
  tags:
5
  - generated_from_trainer
 
 
6
  metrics:
7
  - f1
8
  model-index:
@@ -24,18 +26,16 @@ It achieves the following results on the evaluation set:
24
  - F1: 0.9883
25
 
26
  ## Model description
 
27
 
28
- More information needed
29
-
30
- ## Intended uses & limitations
31
-
32
- More information needed
33
 
34
  ## Training and evaluation data
35
 
36
- More information needed
37
-
38
- ## Training procedure
39
 
40
  ### Training hyperparameters
41
 
 
3
  base_model: xlm-roberta-base
4
  tags:
5
  - generated_from_trainer
6
+ - NER
7
+ - crypto
8
  metrics:
9
  - f1
10
  model-index:
 
26
  - F1: 0.9883
27
 
28
  ## Model description
29
+ This model is a fine-tuned version of xlm-roberta-base, specializing in Named Entity Recognition (NER) within the cryptocurrency domain. It is optimized to recognize and classify entities such as cryptocurrency ticker symbols, names, and addresses within text.
30
 
31
+ ## Intended uses
32
+ Designed primarily for NER tasks in the cryptocurrency sector, this model excels in identifying and categorizing ticker symbols, cryptocurrency names, and addresses in textual content.
33
+ ## Limitations
34
+ The model might not perform well in identifying and classifying entities that were not part of the training data or those that are less frequent in the cryptocurrency domain. It may also be sensitive to the context and format in which the entities are presented.
 
35
 
36
  ## Training and evaluation data
37
 
38
+ The model was trained using a diverse dataset, including artificially generated tweets and ERC20 token metadata fetched through the [Covalent API](https://www.covalenthq.com/docs/unified-api/). GPT was employed to generate 500 synthetic tweets tailored for the cryptocurrency domain. The Covalent API was instrumental in obtaining a rich set of 20K+ unique ERC20 token metadata entries, enhancing the model's understanding and recognition of cryptocurrency entities.## Training procedure
 
 
39
 
40
  ### Training hyperparameters
41