Inserloft commited on
Commit
157501c
Β·
verified Β·
1 Parent(s): d83bd24

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +111 -3
README.md CHANGED
@@ -1,3 +1,111 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ language:
4
+ - en
5
+ base_model:
6
+ - Inserloft/Cleo-Kyro
7
+ tags:
8
+ - AI
9
+ - Cleo
10
+ - Open-Source
11
+ ---
12
+
13
+ ---
14
+ license: mit
15
+ language:
16
+ - en
17
+ - es
18
+ tags:
19
+ - llm
20
+ - chatbot
21
+ - ai-assistant
22
+ - open-source
23
+ - inserloft
24
+ ---
25
+
26
+ # 🧠 Cleo-Kyro
27
+
28
+ **Cleo-Kyro** is an experimental AI assistant model developed by **Inserloft**, designed to provide a modern, flexible, and open-source conversational experience.
29
+
30
+ > Create. Imagine. Transform.
31
+
32
+ ---
33
+
34
+ ## ✨ Overview
35
+
36
+ Cleo-Kyro is part of the **Cleo ecosystem**, a next-generation AI assistant project focused on usability, creativity, and accessibility.
37
+
38
+ This repository contains an **open-source version** of the Cleo model, intended for developers, researchers, and enthusiasts.
39
+
40
+ ---
41
+
42
+ ## πŸš€ Features
43
+
44
+ - πŸ’¬ Conversational AI assistant
45
+ - 🧠 Context-aware responses
46
+ - ⚑ Lightweight & flexible usage
47
+ - πŸ”“ Open-source (MIT)
48
+ - 🧩 Easy integration with local and cloud environments
49
+
50
+ ---
51
+
52
+ ## πŸ“¦ Installation
53
+
54
+ Make sure you have the Hugging Face CLI installed:
55
+
56
+ ```bash
57
+ pip install -U huggingface_hub
58
+ ```
59
+
60
+ ## πŸ“₯ Download Model
61
+
62
+ Download the full model:
63
+ ```bash
64
+ huggingface-cli download Inserloft/Cleo-Kyro --local-dir ./model
65
+ ```
66
+
67
+ Download specific files (recommended):
68
+ ```bash
69
+ huggingface-cli download Inserloft/Cleo-Kyro \
70
+ --include "*.gguf" \
71
+ --local-dir ./model
72
+ ```
73
+
74
+ # πŸ§ͺ Usage (Example)
75
+ ```bash
76
+ from transformers import AutoTokenizer, AutoModelForCausalLM
77
+
78
+ tokenizer = AutoTokenizer.from_pretrained("Inserloft/Cleo-Kyro")
79
+ model = AutoModelForCausalLM.from_pretrained("Inserloft/Cleo-Kyro")
80
+
81
+ inputs = tokenizer("Hello Cleo!", return_tensors="pt")
82
+ outputs = model.generate(**inputs, max_new_tokens=100)
83
+
84
+ print(tokenizer.decode(outputs[0]))
85
+ ```
86
+
87
+ # 🧩 Project Structure
88
+ Component | Description
89
+ Cleo-Kyro | Open-source model
90
+ Cleo (UI) | Interface / assistant experience
91
+
92
+ # πŸ”’ Versions
93
+ Cleo-Kyro (this repo) β†’ Open-source version
94
+ Kyro 1.5 β†’ Experimental / not publicly available
95
+ Future versions may include private and advanced models
96
+
97
+ # ⚠️ Disclaimer
98
+
99
+ This is an experimental model and may produce inaccurate or unexpected outputs.
100
+
101
+ Use responsibly.
102
+
103
+ # 🌐 Links
104
+ ### 🌍 Website: https://inserloft.dev
105
+ ### πŸ€— Hugging Face: https://huggingface.co/Inserloft/Cleo-Kyro
106
+ ### 🐦 X (Twitter): https://x.com/Inserloft
107
+ ### πŸ“Έ Instagram: https://instagram.com/Inserloft
108
+
109
+ # πŸ“œ License
110
+
111
+ MIT License β€” feel free to use, modify, and build upon this project.