Create README.md

README.md

@@ -0,0 +1,126 @@
+---
+language: en
+license: llama3
+tags:
+- large_language_model
+- finance
+- sec_data
+- continual_pre_training
+datasets:
+- SEC_filings
+---
+
+<img src="https://i.ibb.co/kHtBmDN/w8m6-X4-HCQRa-IR86ar-Cm5gg.webp" width="600" />
+
+# GGUF Quantizations for Llama-3-SEC: A Domain-Specific Chat Agent for SEC Data Analysis
+
+Llama-3-SEC is a state-of-the-art domain-specific large language model trained on a vast corpus of SEC (Securities and Exchange Commission) data. Built upon the powerful Meta-Llama-3-70B-Instruct model, Llama-3-SEC has been developed to provide unparalleled insights and analysis capabilities for financial professionals, investors, researchers, and anyone working with SEC filings and related financial data.
+
+GGUF files converted with <a href="https://github.com/ggerganov/llama.cpp/">llama.cpp</a> release <a href="https://github.com/ggerganov/llama.cpp/releases/tag/b3166">b3166</a>. Imatrix calibrated with the dataset found [here](https://gist.github.com/bartowski1182/eb213dccb3571f863da82e99418f81e8).
+
+## Model Details
+
+- **Base Model:** Meta-Llama-3-70B-Instruct
+- **Training Data:** 19B tokens of SEC filings data, carefully mixed with 1B tokens of general data from Together AI's RedPajama dataset: [RedPajama-Data-1T](https://huggingface.co/datasets/togethercomputer/RedPajama-Data-1T) to maintain a balance between domain-specific knowledge and general language understanding.
+- **Training Method:** Continual Pre-Training (CPT) using the Megatron-Core framework, followed by model merging with the base model using the state-of-the-art TIES merging technique in the Arcee Mergekit toolkit. It then underwent supervised fine-tuning on an 8xH100 node using [Spectrum](https://arxiv.org/abs/2406.06623). We used a mixture of custom domain specific and general open-source datasets.
+- **Training Infrastructure:** AWS SageMaker HyperPod cluster with 4 nodes, each equipped with 32 H100 GPUs, ensuring efficient and scalable training of this massive language model.
+
+## Use Cases
+
+Llama-3-SEC is designed to assist with a wide range of tasks related to SEC data analysis, including but not limited to:
+
+- In-depth investment analysis and decision support
+- Comprehensive risk management and assessment
+- Ensuring regulatory compliance and identifying potential violations
+- Studying corporate governance practices and promoting transparency
+- Conducting market research and tracking industry trends
+
+The model's deep understanding of SEC filings and related financial data makes it an invaluable tool for anyone working in the financial sector, providing powerful natural language processing capabilities tailored to the specific needs of this domain.
+
+## Evaluation
+
+To ensure the robustness and effectiveness of Llama-3-SEC, the model has undergone rigorous evaluation on both domain-specific and general benchmarks. Key evaluation metrics include:
+
+- Domain-specific perplexity, measuring the model's performance on SEC-related data
+
+<img src="https://i.ibb.co/K5d0wMh/Screenshot-2024-06-11-at-10-23-18-PM.png" width="600">
+
+- Extractive numerical reasoning tasks, using subsets of TAT-QA and ConvFinQA datasets
+
+<img src="https://i.ibb.co/xGHRfLf/Screenshot-2024-06-11-at-10-23-59-PM.png" width="600">
+
+- General evaluation metrics, such as BIG-bench, AGIEval, GPT4all, and TruthfulQA, to assess the model's performance on a wide range of tasks
+
+<img src="https://i.ibb.co/2v6PdDx/Screenshot-2024-06-11-at-10-25-03-PM.png" width="600">
+
+These results demonstrate significant improvements in domain-specific performance while maintaining strong general capabilities, thanks to the use of advanced CPT and model merging techniques.
+
+## Training and Inference
+
+Llama-3-SEC has been trained using the chatml chat template. This template ensures that the model maintains its strong conversational abilities while incorporating the domain-specific knowledge acquired during the CPT process.
+
+To run inference with the Llama-3-SEC model using the chatml chat template, you can use the following code:
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+device = "cuda"
+
+model_name = "arcee-ai/Llama-3-SEC"
+
+model = AutoModelForCausalLM.from_pretrained(
+    model_name,
+    torch_dtype="auto",
+    device_map="auto"
+)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+
+prompt = "What are the key regulatory considerations for a company planning to conduct an initial public offering (IPO) in the United States?"
+messages = [
+    {"role": "system", "content": "You are an expert financial assistant - specializing in governance and regulatory domains."},
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(device)
+
+generated_ids = model.generate(
+    model_inputs.input_ids,
+    max_new_tokens=512
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids, skip_special_tokens=True)[0]
+```
+
+## Limitations and Future Work
+
+This release represents the initial checkpoint of the Llama-3-SEC model, trained on 20B tokens of SEC data. Additional checkpoints will be released in the future as training on the full 70B token dataset is completed. Future work will focus on further improvements to the CPT data processing layer, exploration of advanced model merging techniques, and alignment of CPT models with SFT, DPO, and other cutting-edge alignment methods to further enhance the model's performance and reliability.
+
+## Usage
+
+The model is available for both commercial and non-commercial use under the Llama-3 license. We encourage users to explore the model's capabilities and provide feedback to help us continuously improve its performance and usability. For more information - please see our detailed blog on Llama-3-SEC.
+
+**Note:** We trained Llama-3-SEC to be very compliant with system prompts. We have included a default system prompt, but if you wish to tailor answers to what your specific use case is, creating a system prompt that outlines your desired behavior is recommended.
+
+**Disclaimer:** Llama-3-SEC is a large language model (LLM) designed to assist with SEC data analysis. Users are solely responsible for any actions taken as a result of using Llama-3-SEC. Always double-check model responses.
+
+## Citation
+
+If you use this model in your research or applications, please cite:
+
+```bibtex
+@misc{Introducing_SEC_Data_Chat_Agent, 
+      title={Introducing the Ultimate SEC Data Chat Agent: Revolutionizing Financial Insights}, 
+      author={Shamane Siriwardhana and Luke Mayers and Thomas Gauthier and Jacob Solawetz and Tyler Odenthal and Anneketh Vij and Lucas Atkins and Charles Goddard and Mary MacCarthy and Mark McQuade},
+      year={2024},
+      note={Available at: \url{[email protected]}},
+      url={URL after published}
+}
+```
+
+For further information or inquiries, please contact the authors at their respective email addresses ([email protected]). We look forward to seeing the exciting applications and research that will emerge from the use of Llama-3-SEC in the financial domain.