Upload README.md with huggingface_hub

README.md

@@ -1,32 +1,76 @@
 ---
+license: creativeml-openrail-m
 language:
 - sq
-license: bigscience-openrail-m
-library_name: adapter-transformers
-metrics:
-- accuracy
 ---
+Here is the revised `README.md` file for the Bleta-8B model:
 
----
-# Bleta-8B-v.05: Modeli i Përmirësuar i Gjuhës për Shqipen
+```markdown
+# Bleta-8B Model
+
+**License:** [CreativeML OpenRAIL-M](https://huggingface.co/spaces/CompVis/stable-diffusion-license)
+
+## Overview
+
+Bleta-8B is a state-of-the-art language model designed to generate coherent and contextually relevant text for a variety of applications, including dialogue generation, content creation, and more.
+
+## Model Details
+
+- **Model Name:** Bleta-8B
+- **Model Size:** 8 Billion parameters
+- **Format:** GGUF
+- **License:** CreativeML OpenRAIL-M
+
+## Files and Versions
+
+- `adapter_config.json`: Configuration file for the model adapter.
+- `adapter_model.safetensors`: The model weights in safetensors format.
+- `config.json`: Basic configuration file.
+- `special_tokens_map.json`: Mapping of special tokens.
+- `tokenizer.json`: Tokenizer configuration.
+- `tokenizer_config.json`: Detailed tokenizer settings.
+- `Q8_0.gguf`: The model file in GGUF format.
+
+## Getting Started
+
+### Prerequisites
+
+- Ensure you have the necessary dependencies installed, such as `cmake`, `make`, and a C++ compiler like `g++`.
+- Clone and build the `llama.cpp` repository:
+
+  ```bash
+  git clone https://github.com/ggerganov/llama.cpp
+  cd llama.cpp
+  mkdir build
+  cd build
+  cmake ..
+  make
+  ```
+
+### Download the Model
 
-Bleta-8B-v.05 është një model i përmirësuar në gjuhën shqipe, i zhvilluar me përdorimin e librarisë "adapter-transformers". Ky model është e përshtatur për të punuar me gjuhën shqipe dhe përdor një dataset të pastër për të trajnuar dhe rritur performancën.
+Download the model file from the repository:
 
-## Licenca
+```bash
+wget https://huggingface.co/klei1/bleta-8b/resolve/main/unsloth.Q8_0.gguf
+```
 
-Bleta-8B-v.05 është publikuar nën licensën The BigScience OpenRAIL-M License .
+### Running the Model
 
-___
+Use the `llama.cpp` executable to run the model with your desired prompt:
 
+```bash
+./main -m unsloth.Q8_0.gguf -p "Your prompt here"
+```
 
-Copyright 2024 Klei Aliaj Dialogo. All Rights Reserved.
+Replace `"Your prompt here"` with the text you want to process with the model.
 
-This work is protected under copyright laws and international treaties. No part of this work may be reproduced, distributed, or transmitted in any form or by any means, including photocopying, recording, or other electronic or mechanical methods, without the prior written permission of Klei Aliaj Dialogo, except in the case of brief quotations embodied in critical reviews and certain other noncommercial uses permitted by copyright law.
+#### Example Command
 
-For permission requests, write to Klei Aliaj Dialogo at the following address:
+```bash
+./main -m unsloth.Q8_0.gguf -p "Hello, world!"
+```
 
-Klei Aliaj Dialogo
-klei@trydialogo.com
-Tirana, Albania
+## License
 
-https://dialogo.chat/
+This model is licensed under the CreativeML OpenRAIL-M.