README.md

---
license: apache-2.0
base_model: PygmalionAI/Eleusis-12B
tags:
- llama-cpp
- gguf-my-repo
---

# Triangle104/Eleusis-12B-Q4_K_M-GGUF
This model was converted to GGUF format from [`PygmalionAI/Eleusis-12B`](https://huggingface.co/PygmalionAI/Eleusis-12B) using llama.cpp via the ggml.ai's [GGUF-my-repo](https://huggingface.co/spaces/ggml-org/gguf-my-repo) space.
Refer to the [original model card](https://huggingface.co/PygmalionAI/Eleusis-12B) for more details on the model.

---
Alongside the release of Pygmalion-3, we present an additional roleplay model based on Mistral's Nemo Base named Eleusis,
 a unique model that has a distinct voice among its peers. Though it was
 meant to be a test run for further experiments, this model was received
 warmly to the point where we felt it was right to release it publicly.


We release the weights of Eleusis under the Apache 2.0 license, ensuring a free and open ecosystem for it to flourish under.



	
		
	

		Prompting
	



Like its component models, Eleusis utilizes the standard ChatML format.


<|im_start|>system
Your responses must be detailed, creative, immersive, and drive the scenario forward.<|im_end|>
<|im_start|>user
{{user}}: Good evening!<|im_end|>
<|im_start|>assistant
{{char}}: 



Note that this system prompt is an example and experimentation is encouraged for your use-case purposes. {{user}} and {{char}} are placeholder names and should be replaced with the user's name and the character to be roleplayed as by the model.



	
		
	

		Limitations and biases
	



The intended use-case for this model is fictional writing for entertainment purposes. Any other sort of usage is out of scope.


As such, it was not fine-tuned to be safe and 
harmless: the base model and this fine-tune have been trained on data 
known to contain profanity and texts that are lewd or otherwise 
offensive. It may produce socially unacceptable or undesirable text, 
even if the prompt itself does not include anything explicitly 
offensive. Outputs might often be factually wrong or misleading.



	
		
	

		Acknowledgements
	



A warm thank you is required for the creators of the models we used 
to construct Eleusis, and a huge shout out once more to Pyg's wonderful 
community, who's with us every step of the way.

---
## Use with llama.cpp
Install llama.cpp through brew (works on Mac and Linux)

```bash
brew install llama.cpp

```
Invoke the llama.cpp server or the CLI.

### CLI:
```bash
llama-cli --hf-repo Triangle104/Eleusis-12B-Q4_K_M-GGUF --hf-file eleusis-12b-q4_k_m.gguf -p "The meaning to life and the universe is"
```

### Server:
```bash
llama-server --hf-repo Triangle104/Eleusis-12B-Q4_K_M-GGUF --hf-file eleusis-12b-q4_k_m.gguf -c 2048
```

Note: You can also use this checkpoint directly through the [usage steps](https://github.com/ggerganov/llama.cpp?tab=readme-ov-file#usage) listed in the Llama.cpp repo as well.

Step 1: Clone llama.cpp from GitHub.
```
git clone https://github.com/ggerganov/llama.cpp
```

Step 2: Move into the llama.cpp folder and build it with `LLAMA_CURL=1` flag along with other hardware-specific flags (for ex: LLAMA_CUDA=1 for Nvidia GPUs on Linux).
```
cd llama.cpp && LLAMA_CURL=1 make
```

Step 3: Run inference through the main binary.
```
./llama-cli --hf-repo Triangle104/Eleusis-12B-Q4_K_M-GGUF --hf-file eleusis-12b-q4_k_m.gguf -p "The meaning to life and the universe is"
```
or 
```
./llama-server --hf-repo Triangle104/Eleusis-12B-Q4_K_M-GGUF --hf-file eleusis-12b-q4_k_m.gguf -c 2048
```