alkibijad commited on
Commit
dc6e60e
1 Parent(s): 4cc43fe

Add English readme

Browse files
Files changed (2) hide show
  1. README.en.md +50 -0
  2. README.md +3 -1
README.en.md ADDED
@@ -0,0 +1,50 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ base_model: gordicaleksa/YugoGPT
3
+ inference: false
4
+ language:
5
+ - sr
6
+ - hr
7
+ license: apache-2.0
8
+ model_creator: gordicaleksa
9
+ model_name: YugoGPT
10
+ model_type: mistral
11
+ quantized_by: Luka Secerovic
12
+ ---
13
+ [![sr](https://img.shields.io/badge/lang-sr-green.svg)](https://huggingface.co/alkibijad/YugoGPT-GGUF/blob/main/README.md)
14
+ [![en](https://img.shields.io/badge/lang-en-red.svg)](https://huggingface.co/alkibijad/YugoGPT-GGUF/blob/main/README.en.md)
15
+
16
+ # About the model
17
+ [YugoGPT](https://huggingface.co/gordicaleksa/YugoGPT) is currently the best open-source base 7B LLM for BCS (Bosnian, Croatian, Serbian).
18
+
19
+ This repository contains the model in [GGUF](https://github.com/ggerganov/llama.cpp/tree/master) format, which is very useful for local inference, and doesn't require expensive hardware.
20
+
21
+ # Versions
22
+ The model is compressed into a couple of smaller versions. Compression drops the quality slightly, but significantly increases the inference speed.
23
+
24
+ It's suggested to use the `Q4_1` version as it's the fastest one.
25
+
26
+
27
+ | Name | Size (GB) | Note |
28
+ |-------|---------------|----------------------------------------------------------------------------|
29
+ | Q4_1 | 4.55 | Weights compressed to 4 bits. The fastest version. |
30
+ | q8_0 | 7.7 | Weights compressed to 8 bits. |
31
+ | fp16 | 14.5 | Weights compressed to 16 bits. |
32
+ | fp32 | 29 | Original, 32 bit weights. Not recommended to use this. |
33
+
34
+ # How to run this model locally?
35
+ ## LMStudio - the easiest way ⚡️
36
+ Install [LMStudio](https://lmstudio.ai/).
37
+
38
+ - After installation, search for "alkibijad/YugoGPT":
39
+ ![Pretraga](./media/lm_studio_screen_1.png "Pretraga modela")
40
+ - Choose a model version (recommended `Q4_1`):
41
+ ![Izaberi model](./media/lm_studio_screen_2.1.png "Izaberi model")
42
+ - After the model finishes downloading, click on "chat" on the left side and start chatting:
43
+ - [Optional] You can setup a system prompt, e.g. "You're a helpful assistant" or however else you want.
44
+ ![Chat](./media/lm_studio_screen_3.png "Chat")
45
+
46
+ That's it!
47
+
48
+ ## llama.cpp - advanced 🤓
49
+ Ako si napredan korisnik i želiš da se petljaš sa komandnom linijom i naučiš više o `GGUF` formatu, idi na [llama.cpp](https://github.com/ggerganov/llama.cpp/tree/master) i pročitaj uputstva 🙂
50
+ If you're an advanced user and want to use CLI and learn more about `GGUF` format, go to [llama.cpp](https://github.com/ggerganov/llama.cpp/tree/master) and follow the instructions 🙂
README.md CHANGED
@@ -10,6 +10,8 @@ model_name: YugoGPT
10
  model_type: mistral
11
  quantized_by: Luka Secerovic
12
  ---
 
 
13
  # O modelu
14
  [YugoGPT](https://huggingface.co/gordicaleksa/YugoGPT) je trenutno najbolji "open source" model za srpski, hvatska, bosanski... i sve ostale jezike na koje uspemo da se "podelimo" 🙂
15
 
@@ -37,8 +39,8 @@ Najlakši način je da se prvo instalira [LMStudio](https://lmstudio.ai/), progr
37
  - Izaberi neki od modela (preporučeno `Q4_1`):
38
  ![Izaberi model](./media/lm_studio_screen_2.1.png "Izaberi model")
39
  - Nakon što se model "skine", klikni na "chat" u levom delu ekrana i možeš da ćaskaš sa modelom:
40
- ![Chat](./media/lm_studio_screen_3.png "Chat")
41
  - [Opciono] Možeš da podesiš "system prompt", npr. "Ti si AI asistent koji uvek želi da pomogne." ili kako god već hoćeš.
 
42
 
43
  To je to!
44
 
 
10
  model_type: mistral
11
  quantized_by: Luka Secerovic
12
  ---
13
+ [![sr](https://img.shields.io/badge/lang-sr-green.svg)](https://huggingface.co/alkibijad/YugoGPT-GGUF/blob/main/README.md)
14
+ [![en](https://img.shields.io/badge/lang-en-red.svg)](https://huggingface.co/alkibijad/YugoGPT-GGUF/blob/main/README.en.md)
15
  # O modelu
16
  [YugoGPT](https://huggingface.co/gordicaleksa/YugoGPT) je trenutno najbolji "open source" model za srpski, hvatska, bosanski... i sve ostale jezike na koje uspemo da se "podelimo" 🙂
17
 
 
39
  - Izaberi neki od modela (preporučeno `Q4_1`):
40
  ![Izaberi model](./media/lm_studio_screen_2.1.png "Izaberi model")
41
  - Nakon što se model "skine", klikni na "chat" u levom delu ekrana i možeš da ćaskaš sa modelom:
 
42
  - [Opciono] Možeš da podesiš "system prompt", npr. "Ti si AI asistent koji uvek želi da pomogne." ili kako god već hoćeš.
43
+ ![Chat](./media/lm_studio_screen_3.png "Chat")
44
 
45
  To je to!
46