From ffe268ef2686e489e948356403ec6b6cce0ad621 Mon Sep 17 00:00:00 2001 From: Jasper Kyle Catapang Date: Thu, 1 Jun 2023 12:44:54 +0000 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 256f737..e21799b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ --- -license: apache-2.0 +license: cc-by-sa-4.0 pipeline_tag: text-generation --- @@ -24,9 +24,13 @@ FinOPT-Washington is designed to assist users in obtaining relevant and reliable 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. ## Usage -To use FinOPT-Washington, you may use the following template: +To use FinOPT-Washington, 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-Washington in your work: ```python +# This code uses FinOPT-Washington, a language model developed by MayaPH. +# The model is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license. +# For more information, visit: https://creativecommons.org/licenses/by-sa/4.0/ + from transformers import AutoTokenizer, AutoModelForCausalLM tokenizer = AutoTokenizer.from_pretrained("MayaPH/FinOPT-Washington") @@ -34,6 +38,8 @@ tokenizer = AutoTokenizer.from_pretrained("MayaPH/FinOPT-Washington") model = AutoModelForCausalLM.from_pretrained("MayaPH/FinOPT-Washington") ``` +Please ensure that you include the relevant attribution notice in your code or any other form of usage to comply with the license terms. + ## Limitations and Caveats While FinOPT-Washington has been fine-tuned on a financial question-answering dataset, it is important to note the following limitations and caveats: