uploaded readme

README.md

@@ -0,0 +1,148 @@
+Quantization made by Richard Erkhov.
+
+[Github](https://github.com/RichardErkhov)
+
+[Discord](https://discord.gg/pvy7H8DZMG)
+
+[Request more models](https://github.com/RichardErkhov/quant_request)
+
+
+climategpt-7b - GGUF
+- Model creator: https://huggingface.co/eci-io/
+- Original model: https://huggingface.co/eci-io/climategpt-7b/
+
+
+| Name | Quant method | Size |
+| ---- | ---- | ---- |
+| [climategpt-7b.Q2_K.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q2_K.gguf) | Q2_K | 2.36GB |
+| [climategpt-7b.IQ3_XS.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.IQ3_XS.gguf) | IQ3_XS | 2.61GB |
+| [climategpt-7b.IQ3_S.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.IQ3_S.gguf) | IQ3_S | 2.75GB |
+| [climategpt-7b.Q3_K_S.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q3_K_S.gguf) | Q3_K_S | 2.75GB |
+| [climategpt-7b.IQ3_M.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.IQ3_M.gguf) | IQ3_M | 2.9GB |
+| [climategpt-7b.Q3_K.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q3_K.gguf) | Q3_K | 3.07GB |
+| [climategpt-7b.Q3_K_M.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q3_K_M.gguf) | Q3_K_M | 3.07GB |
+| [climategpt-7b.Q3_K_L.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q3_K_L.gguf) | Q3_K_L | 3.35GB |
+| [climategpt-7b.IQ4_XS.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.IQ4_XS.gguf) | IQ4_XS | 3.4GB |
+| [climategpt-7b.Q4_0.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q4_0.gguf) | Q4_0 | 3.56GB |
+| [climategpt-7b.IQ4_NL.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.IQ4_NL.gguf) | IQ4_NL | 3.58GB |
+| [climategpt-7b.Q4_K_S.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q4_K_S.gguf) | Q4_K_S | 3.59GB |
+| [climategpt-7b.Q4_K.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q4_K.gguf) | Q4_K | 3.8GB |
+| [climategpt-7b.Q4_K_M.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q4_K_M.gguf) | Q4_K_M | 3.8GB |
+| [climategpt-7b.Q4_1.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q4_1.gguf) | Q4_1 | 3.95GB |
+| [climategpt-7b.Q5_0.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q5_0.gguf) | Q5_0 | 4.33GB |
+| [climategpt-7b.Q5_K_S.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q5_K_S.gguf) | Q5_K_S | 4.33GB |
+| [climategpt-7b.Q5_K.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q5_K.gguf) | Q5_K | 4.46GB |
+| [climategpt-7b.Q5_K_M.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q5_K_M.gguf) | Q5_K_M | 4.46GB |
+| [climategpt-7b.Q5_1.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q5_1.gguf) | Q5_1 | 4.72GB |
+| [climategpt-7b.Q6_K.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q6_K.gguf) | Q6_K | 5.15GB |
+| [climategpt-7b.Q8_0.gguf](https://huggingface.co/RichardErkhov/eci-io_-_climategpt-7b-gguf/blob/main/climategpt-7b.Q8_0.gguf) | Q8_0 | 6.67GB |
+
+
+
+
+Original model description:
+---
+language:
+- en
+datasets:
+- OpenAssistant/oasst1
+- databricks/databricks-dolly-15k
+base_model: meta-llama/Llama-2-7b-hf
+tags:
+- climate
+co2_eq_emissions:
+  emissions: 2900
+  training_type: "pre-training"
+  geographical_location: "Washington, USA"
+  hardware_used: "8x NVIDIA H100 HBM"
+license: other
+license_name: climategpt-community-license
+license_link: https://huggingface.co/eci-io/climategpt-7b/blob/main/LICENSE.txt
+---
+# ClimateGPT-7B
+
+ClimateGPT is a family of AI models designed to synthesize interdisciplinary research on climate change.
+ClimateGPT-7B is a 7 billion parameter transformer decoder model that was adapted from Llama-2 to the domain of climate science using continuous pre-training on a collection of 4.2B tokens from curated climate documents created by Erasmus AI.
+The model is further instruction fine-tuned on a dataset of instruction-completion pairs manually collected by AppTek in cooperation with climate scientists.
+ClimateGPT-7B outperforms Llama-2-70B Chat on our climate-specific benchmarks.
+The model is designed to be used together with retrieval augmentation to extend the knowledge, and increase the factuality of the model and with cascaded machine translation to increase the language coverage.
+
+## Model Details
+Explore the model lineage [here](https://huggingface.co/spaces/EQTYLab/lineage-explorer?repo=https://huggingface.co/eci-io/climategpt-7b). 
+
+- **Powered by:** [Erasmus AI](https://erasmus.ai)
+- **Trained with:** [AppTek](https://apptek.com)
+- **Authenticated by:** [EQTYLab](https://eqtylab.io)
+- **Model type:** decoder-only Transformer
+- **Language(s) (NLP):** English
+- **License:** ClimateGPT Community License
+- **Continued pre-trained from:** Llama-2-7B
+- **Context length:** 4K tokens
+- **Input:** Text-only data
+- **Output:** Model generates text only
+- **Paper:** [arXiv:2401.09646](https://arxiv.org/abs/2401.09646)
+- **Website:** [eci.io](https://eci.io)
+
+## Uses
+- This model is intended to be directly used as a question answering model that is specialized in the climate domain.
+- The model is aimed at providing useful feedback for decision makers, scientists and journalists involved in climate discussions.
+- The model can also be used as a starting point for interested developers for further fine-tuning.
+- The model is NOT intended to be a general-purpose chatbot (although it has chat capabilities).
+- For the full system including cascaded MT, RAG, etc., we recommend the user to go to our demo website: [eci.io](https://eci.io)
+- **Despite the efforts from the development team to eliminate them, as every other chat-capable LLMs, this model may generate biased, offensive or inaccurate responses.**
+
+## Downstream Use
+
+ClimateGPT-7B is an instruction-tuned model that can be directly used for climate-specific question-answering applications.
+It was trained to perform well with retrieval augmentation and supports up to 5 references in context.
+
+The model was trained using ChatML so the following format should be followed when prompting, including the  `<|im_start|>`, `<|im_end|>` tags, `system`, `user`, `context` and `assistant` identifiers and `[[0]]`, `[[1]]]` etc. tokens to indicate references.
+    
+    """
+    <|im_start|>system
+    {system_message}<|im_end|>
+    <|im_start|>user
+    {prompt}<|im_end|>
+    <|im_start|>context
+    [[0]] "{reference1_title}", {reference1_year}
+    {reference1_text}
+    [[1]] "{reference2_title}", {reference2_year}
+    {reference2_text}
+    [...]<|im_end|>
+    <|im_start|>assistant
+    """
+
+## Training
+- For the Llama-2 training data, we refer the user to https://huggingface.co/meta-llama/Llama-2-7b-hf.
+- For continued pre-training, 4.2B climate-specific tokens (tokenized by the Llama tokenizer) are used.
+- For instruction fine-tuning, about 272K instruction-completion pairs (both in the climate domain but also general domain) are used.
+
+## Evaluation
+
+Detailed evaluation results are presented in our [paper](https://arxiv.org/abs/2401.09646) on our model card website: [eci.io/model-card](https://eci.io/model-card)
+
+## Environmental Impact
+- **Hardware Type:** 8x NVIDIA H100 HBM
+- **Power Consumption per GPU:** 775W
+- **Hours used:** 157 hrs
+- **Cloud Provider:** MLFoundry
+- **Compute Region:** Washington, USA
+- **Energy Mix:** 100% Hydro Power (24g CO2eq/kWh according to IPCC 2014)
+- **Carbon Emitted:** 2.9kg CO2eq
+
+## Citation
+
+If you find ClimateGPT is useful in your work, please cite it with:
+
+```
+@misc{thulke2024climategpt,
+      title={ClimateGPT: Towards AI Synthesizing Interdisciplinary Research on Climate Change}, 
+      author={David Thulke and Yingbo Gao and Petrus Pelser and Rein Brune and Rricha Jalota and Floris Fok and Michael Ramos and Ian van Wyk and Abdallah Nasir and Hayden Goldstein and Taylor Tragemann and Katie Nguyen and Ariana Fowler and Andrew Stanco and Jon Gabriel and Jordan Taylor and Dean Moro and Evgenii Tsymbalov and Juliette de Waal and Evgeny Matusov and Mudar Yaghi and Mohammad Shihadah and Hermann Ney and Christian Dugast and Jonathan Dotan and Daniel Erasmus},
+      year={2024},
+      eprint={2401.09646},
+      archivePrefix={arXiv},
+      primaryClass={cs.LG}
+}
+```
+
+