Update README.md

README.md

@@ -1,3 +1,68 @@
 ---
 license: apache-2.0
+pipeline_tag: text-generation
 ---
+
+# 🤗 FinOPT-Franklin
+
+## Model Description
+FinOPT-Franklin is a language model based on the OPT-1.3B architecture, which has been fine-tuned on a financial question-answering dataset. The model aims to provide accurate and informative responses to financial-related questions.
+
+## FinOPT Series
+The FinOPT series of language models come in various model sizes. Kindly refer to this Huggingface Hub [link](https://huggingface.co/models?search=mayaph/finopt) to see the other checkpoints of FinOPT.
+
+| Model Name          | Parameter Size |
+|---------------------|----------------|
+| <b>FinOPT-Franklin</b>     | <b>1.3B</b>           |
+| FinOPT-Lincoln       | 350M           |
+| FinOPT-Washington | 125M          |
+
+## Intended Use
+FinOPT-Franklin is designed to assist users in obtaining relevant and reliable information about financial topics. It can be used as a tool for performing question-answering tasks in the financial domain, including banking queries, investment advice, and general financial inquiries.
+
+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-Franklin, you may use the following template:
+
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+tokenizer = AutoTokenizer.from_pretrained("MayaPH/FinOPT-Franklin")
+
+model = AutoModelForCausalLM.from_pretrained("MayaPH/FinOPT-Franklin")
+```
+
+## Limitations and Caveats
+While FinOPT-Franklin has been fine-tuned on a financial question-answering dataset, it is important to note the following limitations and caveats:
+
+1. **Domain-Specific Focus:** The model's training data primarily consists of financial questions and answers from the financial QA dataset. It may not perform as well on questions outside the financial domain.
+
+2. **Potential Bias:** The model may reflect biases present in the training data. It is crucial to carefully evaluate and interpret the model's responses, particularly on sensitive topics such as investment advice or financial recommendations.
+
+3. **Confidence and Verification:** The model generates responses based on patterns learned from the training data, but it does not have inherent fact-checking capabilities. Users should verify the information provided by the model from reliable sources before making any financial decisions.
+
+## Training Data
+FinOPT-Franklin was trained on a financial question-answering dataset, which consists of questions and answers related to various financial topics. The dataset was collected from online sources and financial forums, and manually handcrafted.
+
+## Ethical Considerations
+When using FinOPT-Franklin, it is important to consider the following ethical considerations:
+
+1. **Privacy and Security:** Avoid sharing sensitive personal or financial information while interacting with the model. The model does not have privacy safeguards, so exercise caution when discussing personal or confidential matters.
+
+2. **Fairness and Bias:** The model's responses may reflect biases present in the training data. Be aware of potential biases and make an effort to evaluate responses critically and fairly.
+
+3. **Transparency:** The model operates as a predictive text generator based on patterns learned from the training data. The model's inner workings and the specific training data used are proprietary and not publicly available.
+
+4. **User Responsibility:** Users should take responsibility
+
+ for their own financial decisions and not solely rely on the information provided by the model. Consult with financial professionals or reliable sources for specific financial advice or recommendations.
+
+## Further Information
+For additional information or inquiries about FinOPT-Franklin, please contact the Maya Philippines iOps Team via jaspercatapang@maya.ph.
+
+## Disclaimer
+FinOPT-Franklin is an AI language model trained by Maya Philippines. It is provided "as is" without warranty of any kind, express or implied. The model developers and Maya Philippines shall not be liable for any direct or indirect damages arising from the use of this model.
+
+## Acknowledgments
+The development of FinOPT-Franklin was made possible by Maya Philippines and the curation and creation of the financial question-answering dataset.