Add README.md content description

README.md

@@ -1,3 +1,95 @@
 ---
-license: cc-by-nc-sa-3.0
+pipeline_tag: text-generation
+inference: false
+library_name: llama.cpp
+license: cc-by-nc-sa-4.0
+license_name: creative-commons
+license_link: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en
+language:
+ - en
+tags:
+ - text-generation
+ - artificial-intelligence
+ - not-for-all-audiences
 ---
+
+## Valerie v0.1 Model Card
+
+### Overview
+
+Valerie v0.1 is a custom language model created using `llama.cpp` (commit: 532c173) with a context length of 256 tokens, embedding length of 256, 8 heads, and
+16 layers. This model was pretrained on a dataset consisting of female V's dialog from Cyberpunk 2077, extracted using the [Voice Over Subtitle 
+Map](https://www.nexusmods.com/cyberpunk2077/mods/2045) mod.
+
+The `ggml-valerie-v0.1-256x32-f32-LATEST.gguf` release represents a single pass through all 51443 samples, completing one iteration over the entire dataset, 
+and took approximately 3 hours for training.
+
+### Model Information
+
+| Model name | Adam iteration | Model filename |
+| ----------------------- | -------------- | ---------------------------------------- |
+| Valerie v0.1 Checkpoint | 950 | chk-valerie-v0.1-256x32-950.gguf |
+| Valerie v0.1 Model | 1700 | ggml-valerie-v0.1-256x32-f32-LATEST.gguf |
+
+### Files and versions
+
+- ggml-valerie-v0.1-256x32-f32-950.gguf: The pretrained model checkpoint version 950.
+- ggml-valerie-v0.1-256x32-f32-LATEST.gguf: The latest pretrained model checkpoint.
+
+### Settings
+
+- Context length: 256 tokens
+- Embedding length: 256
+- Heads: 8
+- Layers: 16
+- Batch size: 32
+- Seed: 1
+- Saved checkpoint every 50 iterations
+
+### Usage
+
+To use Valerie v0.1, follow these steps:
+
+1. Install the required dependencies (e.g., GGML library).
+
+ ```sh
+ git clone https://github.com/ggerganov/llama.cpp
+ ```
+
+ Reference the `llama.cpp` README.md for more information.
+
+2. Download or clone this repository.
+
+ ```sh
+ wget https://huggingface.co/teleprint-me/cyberpunk/resolve/main/ggml-valerie-v0.1-256x32-f32-LATEST.gguf\?download\=true -O ggml-valerie-v0.1-256x32-f32-LATEST.gguf
+ ```
+
+ This will download the latest available base model.
+
+3. Perform inference with the latest model checkpoint using the provided command:
+
+```sh
+./main -m models/valerie/v0.1/ggml-valerie-v0.1-256x32-f32-LATEST.gguf --color -e -s 1 -c 4096
+```
+
+### Citing Valerie v0.1
+
+When using Valerie v0.1 in your research, please remember to cite the following:
+
+- Aberrio. (2023). Valerie v0.1: A custom language model for female V's dialog from Cyberpunk 2077. https://huggingface.co/teleprint-me/cyberpunk.
+- julieisdead (2021). Voice Over Subtitle Map: Two files that contain the IDs for, Voice Over files the other Subtitles. https://www.nexusmods.com/cyberpunk2077/mods/2045
+- GGML team. (2023). `llama.cpp` version `532c173`. Georgi Gerganov Machine Learning Library. https://github.com/ggerganov/llama.cpp
+
+### Contributors
+
+Austin Berrio (teleprint-me) - Created and trained Valerie v0.1 using `llama.cpp` and the referenced dataset.
+
+### Community
+
+Join the community of fellow language model enthusiasts and researchers by sharing your knowledge, asking questions, and collaborating on projects related to
+creating custom models using `llama.cpp`.
+
+### License
+
+Valerie v0.1 is released under the CC-BY-NC-SA-3.0 license. You are free to use, modify, and redistribute this model for non-commercial purposes, but you must
+provide attribution to the original authors and release any derived works under the same license.