Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,124 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
--
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# π Kail F2
|
| 2 |
+
|
| 3 |
+
**Kail F2** is a lightweight, high-performance open-source language model built entirely from scratch by **Kaniskten Programming**, powered by the custom **Kail2 architecture**.
|
| 4 |
+
|
| 5 |
+
---
|
| 6 |
+
|
| 7 |
+
## π§ Model Overview
|
| 8 |
+
|
| 9 |
+
* **Model Name:** Kail F2
|
| 10 |
+
* **Architecture:** Kail2
|
| 11 |
+
* **Parameters:** 1.5B
|
| 12 |
+
* **Format:** GGUF
|
| 13 |
+
* **Framework Compatibility:** Kail SDK Loader
|
| 14 |
+
|
| 15 |
+
Kail F2 is designed for **speed, efficiency, and accessibility**, making it ideal for local AI applications and low-resource environments.
|
| 16 |
+
|
| 17 |
+
---
|
| 18 |
+
|
| 19 |
+
## β‘ Key Features
|
| 20 |
+
|
| 21 |
+
* πΉ Built completely from scratch (no base model)
|
| 22 |
+
* πΉ Custom **Kail2 architecture**
|
| 23 |
+
* πΉ Optimized GGUF format for fast inference
|
| 24 |
+
* πΉ Low memory footprint
|
| 25 |
+
* πΉ Suitable for local deployment and edge devices
|
| 26 |
+
* πΉ Open-source and extensible
|
| 27 |
+
|
| 28 |
+
---
|
| 29 |
+
|
| 30 |
+
## π₯οΈ Usage
|
| 31 |
+
|
| 32 |
+
Because Kail F2 uses a proprietary, cryptographically secured format (Void Protocol), standard loaders will not recognize it. You must use the provided **Kail SDK Loader** to initialize the model.
|
| 33 |
+
|
| 34 |
+
### 1. Download the Files
|
| 35 |
+
Download both `kail_f2.gguf` and `run_kail_gguf.py` to your local machine.
|
| 36 |
+
|
| 37 |
+
### 2. Run with Kail SDK
|
| 38 |
+
Ensure you have `llama.cpp` compiled on your machine, then run the python loader:
|
| 39 |
+
|
| 40 |
+
```bash
|
| 41 |
+
python3 run_kail_gguf.py
|
| 42 |
+
```
|
| 43 |
+
|
| 44 |
+
*The loader will automatically decrypt the model and launch the interactive engine.*
|
| 45 |
+
|
| 46 |
+
---
|
| 47 |
+
|
| 48 |
+
## π¦ Prerequisites
|
| 49 |
+
|
| 50 |
+
You need standard `llama.cpp` installed on your machine for the loader to interface with:
|
| 51 |
+
|
| 52 |
+
```bash
|
| 53 |
+
git clone https://github.com/ggerganov/llama.cpp
|
| 54 |
+
cd llama.cpp
|
| 55 |
+
make
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
---
|
| 59 |
+
|
| 60 |
+
## π― Example Output
|
| 61 |
+
|
| 62 |
+
**Prompt:**
|
| 63 |
+
|
| 64 |
+
```
|
| 65 |
+
Explain artificial intelligence in simple terms.
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
**Response:**
|
| 69 |
+
|
| 70 |
+
```
|
| 71 |
+
Artificial intelligence is the ability of machines to think, learn, and make decisions like humans. It helps computers solve problems, understand language, and improve over time.
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
---
|
| 75 |
+
|
| 76 |
+
## π Performance
|
| 77 |
+
|
| 78 |
+
Kail F2 is optimized for:
|
| 79 |
+
|
| 80 |
+
* Fast token generation
|
| 81 |
+
* Low latency inference
|
| 82 |
+
* Efficient CPU usage
|
| 83 |
+
|
| 84 |
+
*(Add benchmarks here later for more credibility)*
|
| 85 |
+
|
| 86 |
+
---
|
| 87 |
+
|
| 88 |
+
## π License
|
| 89 |
+
|
| 90 |
+
This project is released under the Apache-2.0 License.
|
| 91 |
+
|
| 92 |
+
---
|
| 93 |
+
|
| 94 |
+
## π¨βπ» Developer
|
| 95 |
+
|
| 96 |
+
Created by **Kaniskten Programming**
|
| 97 |
+
|
| 98 |
+
* π Focus: AI, Software, and Systems
|
| 99 |
+
* π Vision: Building accessible and powerful AI technologies
|
| 100 |
+
|
| 101 |
+
---
|
| 102 |
+
|
| 103 |
+
## π Future Plans
|
| 104 |
+
|
| 105 |
+
* Larger Kail model variants
|
| 106 |
+
* Dedicated Kail runtime (`kail-runner`)
|
| 107 |
+
* API and deployment tools
|
| 108 |
+
|
| 109 |
+
---
|
| 110 |
+
|
| 111 |
+
## π€ Contributing
|
| 112 |
+
|
| 113 |
+
Contributions, ideas, and feedback are welcome.
|
| 114 |
+
Feel free to open issues or submit pull requests.
|
| 115 |
+
|
| 116 |
+
---
|
| 117 |
+
|
| 118 |
+
## β Support
|
| 119 |
+
|
| 120 |
+
If you find this project useful, consider starring β the repository and sharing it.
|
| 121 |
+
|
| 122 |
+
---
|
| 123 |
+
|
| 124 |
+
**Kail F2 β Built from scratch. Designed for the future.**
|