jaspercatapang commited on
Commit
c88b1bf
1 Parent(s): 5b04544

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -2
README.md CHANGED
@@ -1,5 +1,5 @@
1
  ---
2
- license: apache-2.0
3
  pipeline_tag: text-generation
4
  ---
5
 
@@ -24,9 +24,13 @@ FinOPT-Franklin is designed to assist users in obtaining relevant and reliable i
24
  The model is intended to be used by individuals seeking information about financial topics, as well as developers and researchers working on natural language processing (NLP) tasks in the financial domain.
25
 
26
  ## Usage
27
- To use FinOPT-Franklin, you may use the following template:
28
 
29
  ```python
 
 
 
 
30
  from transformers import AutoTokenizer, AutoModelForCausalLM
31
 
32
  tokenizer = AutoTokenizer.from_pretrained("MayaPH/FinOPT-Franklin")
@@ -34,6 +38,8 @@ tokenizer = AutoTokenizer.from_pretrained("MayaPH/FinOPT-Franklin")
34
  model = AutoModelForCausalLM.from_pretrained("MayaPH/FinOPT-Franklin")
35
  ```
36
 
 
 
37
  ## Limitations and Caveats
38
  While FinOPT-Franklin has been fine-tuned on a financial question-answering dataset, it is important to note the following limitations and caveats:
39
 
 
1
  ---
2
+ license: cc-by-sa-4.0
3
  pipeline_tag: text-generation
4
  ---
5
 
 
24
  The model is intended to be used by individuals seeking information about financial topics, as well as developers and researchers working on natural language processing (NLP) tasks in the financial domain.
25
 
26
  ## Usage
27
+ To use FinOPT-Franklin, you are required to provide attribution in accordance with the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license. Please include the following attribution notice when utilizing FinOPT-Franklin in your work:
28
 
29
  ```python
30
+ # This code uses FinOPT-Franklin, a language model developed by Maya Philippines.
31
+ # The model is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.
32
+ # For more information, visit: https://creativecommons.org/licenses/by-sa/4.0/
33
+
34
  from transformers import AutoTokenizer, AutoModelForCausalLM
35
 
36
  tokenizer = AutoTokenizer.from_pretrained("MayaPH/FinOPT-Franklin")
 
38
  model = AutoModelForCausalLM.from_pretrained("MayaPH/FinOPT-Franklin")
39
  ```
40
 
41
+ Please ensure that you include the relevant attribution notice in your code or any other form of usage to comply with the license terms.
42
+
43
  ## Limitations and Caveats
44
  While FinOPT-Franklin has been fine-tuned on a financial question-answering dataset, it is important to note the following limitations and caveats:
45