Update README.md

README.md

@@ -1,3 +1,93 @@
 ---
 license: cc-by-nc-4.0
+datasets:
+- tatsu-lab/alpaca
+library_name: transformers
+pipeline_tag: text-generation
+tags:
+- galactica
+- alpaca
+- opt
+inference: false
 ---
+
+# GALPACA 6.7B (standard)
+
+GALACTICA 30B fine-tuned on the Alpaca dataset.
+
+The model card from the original Galactica repo can be found [here](https://github.com/paperswithcode/galai/blob/main/docs/model_card.md), and the original paper [here](https://galactica.org/paper.pdf).
+
+The dataset card for Alpaca can be found [here](https://huggingface.co/datasets/tatsu-lab/alpaca/blob/main/README.md), and the project homepage [here](https://crfm.stanford.edu/2023/03/13/alpaca.html).
+  The Alpaca dataset was collected with a modified version of the [Self-Instruct Framework](https://github.com/yizhongw/self-instruct), and was built using OpenAI's `text-davinci-003` model. As such it is subject to OpenAI's terms of service.
+
+## Model Details
+
+The GALACTICA models are trained on a large-scale scientific corpus and are designed to perform scientific tasks.
+The Alpaca dataset is a set of 52k instruct-response pairs designed to enhace the instruction following capabilites of pre-trained language models.
+
+## Model Use
+
+The GALACTICA model card specifies that the primary indended users of the GALACTICA models are researchers studying language models applied to the scientific domain, and it cautions against production use of GALACTICA without safeguards due to the potential for the model to produce inaccurate information.
+The original GALACTICA models are available under a non-commercial CC BY-NC 4.0 license, and the GALPACA model is additionally subject to the [OpenAI Terms of Service](https://openai.com/policies/terms-of-use).
+
+## Training Data
+
+The GALPACA models are trained by fine-tuning pre-trained GALACTICA models on the Alpaca dataset. GALACTICA models were trained on 106 billion tokens of open-access scientific text and data, including papers, textbooks, scientific websites, encyclopedias, and more.
+Fine-tuning the base GALACTICA models on the 52k instruction-response pairs in the Alpaca dataset allows users to query the GALPACA models in an instruct-response fashion.
+
+## How to Use
+
+The GALPACA weights are made available for use with the `transformers` library.
+
+<details>
+  <summary> Click to expand </summary>
+
+```python
+# pip install accelerate
+from transformers import AutoTokenizer, OPTForCausalLM
+
+tokenizer = AutoTokenizer.from_pretrained("GeorgiaTechResearchInstitute/galpaca-6.7b")
+model = OPTForCausalLM.from_pretrained("GeorgiaTechResearchInstitute/galpaca-6.7b", device_map="auto", torch_dtype=torch.float16)
+
+# see the original Alpaca repo for more information about the prompt templates
+no_input_prompt_template = ("Below is an instruction that describes a task. "
+                            "Write a response that appropriately completes the request.\n\n"
+                            "### Instruction:\n{instruction}\n\n### Response:")
+prompt = "Write out Maxwell's equations and explain the meaning of each one."
+formatted_prompt = no_input_prompt_template.format_map({'instruction': prompt})
+
+tokenized_prompt = tokenizer(formatted_prompt, return_tensors="pt").input_ids.to(model.device)
+out_tokens = model.generate(tokenized_prompt)
+
+print(tokenizer.batch_decode(out_tokens, skip_special_tokens=False, clean_up_tokenization_spaces=False))
+```
+</details>
+
+## Training Resources
+
+GALPACA 6.7B was fine-tuned in about 2 hours using 4 A100 80GB GPUS, 16-bit mixed-precision, an effective batch-size of 128, and with a maximum context window of 512 tokens. This model was trained using full-shard data parallelism.
+
+## Performance and Limitations
+
+Qualitative evaluation suggests that Galpaca frequently outperforms LLaMA-based Alpaca models on tasks related to technical knowledge and programming, while it underperforms on natural langauge tasks such as generating prose. More information about the performance and limitations of the GALACTICA family of models can be found on the original GALACTICA model card.
+
+## Works Cited
+
+```bibtex
+@inproceedings{GALACTICA,
+    title={GALACTICA: A Large Language Model for Science},
+    author={Ross Taylor and Marcin Kardas and Guillem Cucurull and Thomas Scialom and Anthony Hartshorn and Elvis Saravia and Andrew Poulton and Viktor Kerkez and Robert Stojnic},
+    year={2022}
+}
+```
+
+```bibtex
+@misc{alpaca,
+  author = {Rohan Taori and Ishaan Gulrajani and Tianyi Zhang and Yann Dubois and Xuechen Li and Carlos Guestrin and Percy Liang and Tatsunori B. Hashimoto },
+  title = {Stanford Alpaca: An Instruction-following LLaMA model},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/tatsu-lab/stanford_alpaca}},
+}
+```