Create README_TEMPLATE.md

README_TEMPLATE.md

@@ -0,0 +1,54 @@
+---
+tags:
+- llm-rs
+- ggml
+pipeline_tag: text-generation
+license: apache-2.0
+language:
+- en
+---
+# GGML converted versions of [Together](https://huggingface.co/togethercomputer)'s RedPajama models
+
+## Description
+RedPajama-INCITE-Base-3B-v1 was developed by Together and leaders from the open-source AI community including Ontocord.ai, ETH DS3Lab, AAI CERC, Université de Montréal, MILA - Québec AI Institute, Stanford Center for Research on Foundation Models (CRFM), Stanford Hazy Research research group and LAION. 
+The training was done on 3,072 V100 GPUs provided as part of the INCITE 2023 project on Scalable Foundation Models for Transferrable Generalist AI, awarded to MILA, LAION, and EleutherAI in fall 2022, with support from the Oak Ridge Leadership Computing Facility (OLCF) and INCITE program. 
+
+  - Base Model: [RedPajama-INCITE-Base-3B-v1](https://huggingface.co/togethercomputer/RedPajama-INCITE-Base-3B-v1)
+  - Instruction-tuned Version: [RedPajama-INCITE-Instruct-3B-v1](https://huggingface.co/togethercomputer/RedPajama-INCITE-Instruct-3B-v1)
+  - Chat Version: [RedPajama-INCITE-Chat-3B-v1](https://huggingface.co/togethercomputer/RedPajama-INCITE-Chat-3B-v1)
+
+## Converted Models:
+
+$MODELS$
+
+## Usage
+
+### Python via [llm-rs](https://github.com/LLukas22/llm-rs-python):
+
+#### Installation
+Via pip: `pip install llm-rs`
+
+#### Run inference
+```python
+from llm_rs import AutoModel
+
+#Load the model, define any model you like from the list above as the `model_file`
+model = AutoModel.from_pretrained("rustformers/redpajama-ggml",model_file="RedPajama-INCITE-Base-3B-v1-q4_0-ggjt.bin")
+
+#Generate
+print(model.generate("The meaning of life is"))
+```
+
+### Rust via [Rustformers/llm](https://github.com/rustformers/llm): 
+
+#### Installation
+```
+git clone --recurse-submodules https://github.com/rustformers/llm.git
+cd llm
+cargo build --release
+```
+
+#### Run inference
+```
+cargo run --release -- gptneox infer -m path/to/model.bin  -p "Tell me how cool the Rust programming language is:"
+```